毕设-接口文档

1.宠物订单管理

1.1 订单分页查询

请求路径：/commodity

请求方式：GET

接口描述：该接口用于商品订单列表数据查询

1.1.2 请求参数

/commodity?page=1

1.1.3 响应参数

参数格式：{
"code": 200,
"message": "成功",
"data": {
"content": [
{
// Order 对象实例，包含订单相关信息
},
...
],
"totalElements": 100, // 总记录数
"totalPages": 10, // 总页数
"number": 1, // 当前页码
"size": 10 // 每页显示数量
}
}

1.2添加订单

接口路径：/commodity

HTTP 方法：POST

1.2.1请求参数

请求参数
order (Body)：Order 对象，包含新订单的所有信息，必填

1.2.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

1.3 根据ID获取订单

接口路径：/commodity/{id}

HTTP 方法：GET

1.3.1请求参数

请求参数
id (Path)：订单ID，整数类型，必填

1.3.2响应参数

{
"code": 200,
"message": "成功",
"data": {
// Order 对象实例，包含对应ID的订单信息
}
}

1.4更新订单

接口路径：/commodity

HTTP 方法：PUT

1.4.1请求参数

请求参数
order (Body)：Order 对象，包含要更新的订单信息，必填

1.4.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

1.5根据ID删除订单

接口路径：/commodity

HTTP 方法：DELETE

1.5.1请求参数

请求参数
ids (Query)：订单ID列表，以逗号分隔，例如：ids=1,2,3，必填

1.5.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

2.宠物服务管理

2.1服务信息的分页列表

接口路径：/serve

HTTP 方法：GET

2.1.1请求参数

请求参数
serverPage (Query)：ServerPage 对象，包含分页和查询条件信息，必填

2.1.2响应参数

{
"code": 200,
"message": "成功",
"data": {
"content": [
{
// Server 对象实例，包含服务器相关信息
},
...
],
"totalElements": 100, // 总记录数
"totalPages": 10, // 总页数
"number": 1, // 当前页码
"size": 10 // 每页显示数量
}
}

2.2添加服务

接口路径：/serve

HTTP 方法：POST

2.2.1请求参数

请求参数
server (Body)：Server 对象，包含新服务器的所有信息，必填

2.2.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

2.3根据ID获取服务详情

接口路径：/serve/{id}

HTTP 方法：GET

2.3.1请求参数

请求参数
id (Path)：服务ID，整数类型，必填

2.3.2响应参数

{
"code": 200,
"message": "成功",
"data": {
// Server 对象实例，包含对应ID的服务器信息
}
}

2.4更新指定服务的信息

接口路径：/serve

HTTP 方法：PUT

2.4.1请求参数

请求参数
server (Body)：Server 对象，包含要更新的服务器信息，必填

2.4.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

2.5根据ID删除服务

接口路径：/serve

HTTP 方法：DELETE

2.5.1请求参数

请求参数
ids (Query)：服务器ID列表，以逗号分隔，例如：ids=1,2,3，必填

2.5.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

3.犬类统计管理

3.1获取犬种信息列表

接口路径：/tripartite

HTTP 方法：GET

3.1.1请求参数

无

3.1.2响应参数

{
"code": 200,
"message": "成功",
"data": [
{
// Tripartite 对象实例，包含一个犬种的信息
},
...
]
}

4.犬类登记管理

4.1获取所有犬舍信息

接口地址： /advertising/dogs
请求方式： GET

4.1.1请求参数

无

4.1.2响应参数

{
  "code": 200,
  "message": "成功",
  "data": [
    {
      // ComReport对象的属性
    },
    ...
  ]
}

4.2获取犬种信息

接口地址： /advertising/dogTypes
请求方式： GET

4.2.1请求参数

略

4.2.2响应参数

{
"code": 200,
"message": "成功",
"data": [
{
// Tripartite 对象实例，包含一个犬种的信息
},
...
]
}

4.3添加犬种信息

接口路径：/tripartite

HTTP 方法：POST

4.3.1请求参数

请求参数
tripartite (Body)：Tripartite 对象，包含新犬种的所有信息，必填

4.3.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

4.4根据ID获取犬种信息

接口路径：/tripartite/{id}

HTTP 方法：GET

4.4.1请求参数

请求参数
id (Path)：犬种ID，整数类型，必填

4.4.2响应参数

{
"code": 200,
"message": "成功",
"data": {
// Tripartite 对象实例，包含对应ID的犬种信息
}
}

4.5更新犬种信息

接口路径：/tripartite

HTTP 方法：PUT

4.5.1请求参数

请求参数
tripartite (Body)：Tripartite 对象，包含要更新的犬种信息，必填

4.5.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

4.6删除犬种信息

接口路径：/tripartite

HTTP 方法：DELETE

4.6.1请求参数

请求参数
ids (Query)：犬种ID列表，以逗号分隔，例如：ids=1,2,3，必填

4.6.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

5.犬舍设置

5.1获取犬舍信息的分页列表

接口路径：/comReport

HTTP 方法：GET

5.1.1请求参数

请求参数
comReport (Query)：ComReport 对象，包含分页和查询条件信息，可选

5.1.2响应参数

{
"code": 200,
"message": "成功",
"data": {
"content": [
{
// ComReport 对象实例，包含犬舍的相关信息
},
...
],
"totalElements": 100, // 总记录数
"totalPages": 10, // 总页数
"number": 1, // 当前页码
"size": 10 // 每页显示数量
}
}

5.2添加犬舍信息

接口路径：/comReport

HTTP 方法：POST

5.2.1请求参数

请求参数
comReport (Body)：ComReport 对象，包含新犬舍的所有信息，必填

5.2.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}

5.3 根据ID获取犬舍详情

接口路径：/comReport/{id}

HTTP 方法：GET

5.3.1请求参数

id (Path)：犬舍ID，整数类型，必填

5.3.2响应参数

{
"code": 200,
"message": "成功",
"data": {
// ComReport 对象实例，包含对应ID的犬舍信息
}
}

5.4根据ID删除犬舍信息

接口路径：/comReport/{id}

HTTP 方法：DELETE

5.4.1请求参数

id (Path)：犬舍ID，整数类型，必填

5.4.2响应参数

{
"code": 200,
"message": "成功",
"data": null
}