发现一个好的在线接口文档ShowDoc

目前作者也在用这个在线接口文档,感觉挺好用的就分享出来。
地址: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//版本年份
}
]
}
}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值