目前作者也在用这个在线接口文档,感觉挺好用的就分享出来。
地址:https://www.showdoc.com.cn/
优势:适合小团队开发,简单,快速上手,好维护。
劣势:用了就知道。
用邮箱注册就可以开始编写接口文档了。
赶紧去试试吧!
上效果:
这是我暂时用的模板,直接复制放在showdoc里面就可以。以上图片有以下代码实现。
**简要描述:**
- 问题清单数据列表!
描述
**请求URL:**
- ` http://xxx.xxxxx.xx/xxx/xxx/queryProblemScheduleMsgList`
**请求方式:**
- GET
** Header:**
token:eyJ0eX //token值
**参数:**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|pageNum | 是 | int | 默认1 页码 |
|pageSize | 是 | int | 默认20 页数 |
|tabId | 是 | int | tab标识:1:名称重复tab、2:编码重复、3:可研重复数据。 (默认、1) |
|scheduleId | 是 | String | 当前阶段:默认规划(gh) |
|areaCode | 否 | String | 所属企业 |
|productionYear | 否 | String | 投产年份 |
|yearVersion | 否 | int | 版本年份 |
|scheduleMsgName | 否 | String | 项目名称 |
|projectSource | 否 | String | 项目来源 |
**表名**
描述:查询各个阶段数据。
**返回示例**
{
“success”: true,
“msg”: “查询成功”,
“result”: {
“total”: 10,
“data”: [
{
“scheduleMsgId”: “xxxxxx”,//id
“scheduleId”: “ky”,//阶段id
“scheduleMsgName”: “xxx”,//项目名称
“projectSource”: “网架类”,//项目来源
“productionYear”: “2022-12”,//投产年份
“amountCount”: 122.0,// 总投资(万元)
“belongFirm”: “xxx企业”,//所属企业
“scheduleMsgCode”:“xxx编码”//项目编码
“productionYear”:“xx年份”//投产年份
“yearVersion”:2020//版本年份
}
]
}
}