API文档书写demo
简易的demo，仅供参考
推荐阅读：RESETful API 设计规范，前后端分离实践有感
GET查询
method: GET
api: /v1/xxx/
params:
| 参数名称 | 类型 | 必填 | 说明 | content-type |
|---|---|---|---|---|
| id | string | 是 | multiple/form-data |
response:
| code | msg | data | content-type |
|---|---|---|---|
| error | 传参有误！ | json | |
| success | 获取成功！ | 获取到的数据(见示例) | json |
示例:
{
"code": "success",
"msg": "获取成功！",
"data": [
{
"id": 1,
"data": "",
},
...
]
}
POST新增
method: POST
api: /v1/xxx/
body:
| 参数名称 | 类型 | 必填 | 说明 | content-type |
|---|---|---|---|---|
| id | string | 是 | multiple/form-data | |
| info | string | 是 | multiple/form-data |
response:
| code | msg | content-type |
|---|---|---|
| error | 传参有误！ | json |
| success | 添加成功！ | json |
示例:
{
"code": "success",
"msg": "添加成功！"
}
Delete删除
method: delete
api: /v1/xxx/
body:
| 参数名称 | 类型 | 必填 | 说明 | content-type |
|---|---|---|---|---|
| id | string | 是 | multiple/form-data | |
| info | string | 是 | multiple/form-data |
response:
| code | msg | content-type |
|---|---|---|
| error | 传参有误！ | json |
| success | 删除成功！ | json |
示例:
{
"code": "success",
"msg": "删除成功！"
}