零食分类管理系统API - 后端接口文档

零食分类管理系统API - 后端接口文档

本API文档提供零食分类管理系统的后端接口说明，包括分页查询、列表展示、详情查询、新增、修改、删除等功能，以及提醒接口的说明。

接口说明

1. page：后端接口，用于分页查询零食分类列表，并返回数据。

• 请求方法: GET
• 请求地址: /caipinfenlei/page
• 请求参数:
  • params: Map类型，包含分页参数以及查询条件，例如page、limit、key等。
  • caipinfenlei: CaipinfenleiEntity类型，包含查询条件，可以为空。
• 返回数据: R类型，包含状态码、消息以及分页数据。

2. list：前端接口，用于查询零食分类列表，并返回数据。

• 请求方法: GET
• 请求地址: /caipinfenlei/list
• 请求参数:
  • params: Map类型，包含查询条件，例如key等。
  • caipinfenlei: CaipinfenleiEntity类型，包含查询条件，可以为空。
• 返回数据: R类型，包含状态码、消息以及分页数据。

3. lists：查询零食分类，返回视图列表。

• 请求方法: GET
• 请求地址: /caipinfenlei/lists
• 请求参数:
  • caipinfenlei: CaipinfenleiEntity类型，包含查询条件，可以为空。
• 返回数据: R类型，包含状态码、消息以及视图列表数据。

4. query：查询零食分类详情，返回视图。

• 请求方法: GET
• 请求地址: /caipinfenlei/query
• 请求参数:
  • caipinfenlei: CaipinfenleiEntity类型，包含查询条件。
• 返回数据: R类型，包含状态码、消息以及视图数据。

5. info：后端接口，根据id查询零食分类详情，并返回数据。

• 请求方法: GET
• 请求地址: /caipinfenlei/info/{id}
• 请求参数:
  • id: Long类型，零食分类的ID。
• 返回数据: R类型，包含状态码、消息以及零食分类详情数据。

6. detail：前端接口，根据id查询零食分类详情，并返回数据。

• 请求方法: GET
• 请求地址: /caipinfenlei/detail/{id}
• 请求参数:
  • id: Long类型，零食分类的ID。
• 返回数据: R类型，包含状态码、消息以及零食分类详情数据。

7. save：后端接口，用于保存零食分类信息，并返回成功状态。

• 请求方法: POST
• 请求地址: /caipinfenlei/save
• 请求参数:
  • caipinfenlei: CaipinfenleiEntity类型，包含零食分类信息。
• 返回数据: R类型，包含状态码和消息。

8. add：前端接口，用于新增零食分类信息，并返回成功状态。

• 请求方法: POST
• 请求地址: /caipinfenlei/add
• 请求参数:
  • caipinfenlei: CaipinfenleiEntity类型，包含零食分类信息。
• 返回数据: R类型，包含状态码和消息。

9. update：修改零食分类信息，并返回成功状态。

• 请求方法: PUT
• 请求地址: /caipinfenlei/update
• 请求参数:
  • caipinfenlei: CaipinfenleiEntity类型，包含修改后的零食分类信息。
• 返回数据: R类型，包含状态码和消息。

10. delete：删除零食分类信息，并返回成功状态。

• 请求方法: DELETE
• 请求地址: /caipinfenlei/delete
• 请求参数:
  • ids: Long数组类型，包含要删除的零食分类的ID。
• 返回数据: R类型，包含状态码和消息。

11. remindCount：提醒接口，用于查询符合条件的零食分类数量，并返回数量。

• 请求方法: GET
• 请求地址: /caipinfenlei/remind/{columnName}/{type}
• 请求参数:
  • columnName: String类型，用于指定提醒条件的字段名。
  • type: String类型，用于指定提醒条件的类型，可选值有：
    • 1: 等于
    • 2: 区间
  • map: Map类型，包含提醒条件，例如remindstart、remindend等。
• 返回数据: R类型，包含状态码、消息以及符合条件的零食分类数量。

代码示例

1. 分页查询零食分类列表

// 请求地址：/caipinfenlei/page?page=1&limit=10
Map<String, Object> params = new HashMap<>();
params.put("page", 1);
params.put("limit", 10);
// 可选参数，根据需要添加查询条件
params.put("key", "搜索关键词");
R result = restTemplate.getForObject("/caipinfenlei/page", R.class, params);

2. 保存零食分类信息

CaipinfenleiEntity caipinfenlei = new CaipinfenleiEntity();
// 设置零食分类信息
caipinfenlei.setName("新零食分类");
caipinfenlei.setDescription("新零食分类描述");
// ...
R result = restTemplate.postForObject("/caipinfenlei/save", caipinfenlei, R.class);

3. 查询符合条件的零食分类数量

// 查询创建时间在最近7天内的零食分类数量
Map<String, Object> map = new HashMap<>();
map.put("remindstart", -7); // 7天前
map.put("remindend", 0); // 今天
R result = restTemplate.getForObject("/caipinfenlei/remind/createTime/2", R.class, map);

注意事项

• 所有接口都需要在请求头中设置Content-Type: application/json。
• 接口返回的R类型，包含以下属性：
  • code: 状态码，200表示成功，其他值表示失败。
  • msg: 消息提示。
  • data: 数据内容。
• API文档仅供参考，具体参数和返回值请以实际代码为准。