第一节 编写接口文档

1. 基础数据管理
   1. 国家管理
      1. 列表
         1. 接口描述（get）

获取信息列表。

1. 1. 1. 1. 接口地址

http://localhost:9999/manage-api/baseCountry/list?limit=10&offset=0&deleteFlag=1

协议参数

属性	描述	类型	是否可以为空
limit	一页多少条	Integer	N
offset	分页	Integer	N
deleteFlag	删除状态 1未删除  0已删除	Integer	N
name	国家名称	String	Y

1. 1. 1. 1. 协议响应参数

属性	描述	类型	是否可以为空
total	数据总量	Integer	N
rows	数据集合	List	N
id	主键id	Integer	N
name	名称	String	N
createUser	创建人	String	Y
createTime	联系时间	String	Y
deleteFlag	删除码	Integer	Y
orderNum	顺序码	Integer
username	创建人姓名	String

1. {
2.     "total": 3,
3.     "rows": [
4.         {
5.             "id": 3,
6.             "name": "尼日利亚",
7.             "createUser": 3,
8.             "createTime": "2022-11-10 08:07:00",
9.             "deleteFlag": 1,
10.             "orderNum": 1,
11.             "username": "数据管理"
12.         },
13.    
14.     ]
15. }
    1. 1. 新增
          1. 接口描述（post）

新增化验信息。

1. 1. 1. 1. 功能地址

http://localhost:9999/manage-api/baseCountry/save

协议参数

属性	描述	类型	是否可以为空
name	国家名称	String	N

1. 1. 1. 1. 协议响应参数

属性	描述	类型	是否可以为空
msg	返回信息	Sting	N
flag	true 成功  false 失败	Boolean	N
status	状态编号	Sting	N
data	返回数据集	Map	N

{

    "msg": "新增成功",

    "flag": true,

    "data": null,

    "status": "C00200"

}