在线接口文档管理工具推荐，支持在线测试，HTTP接口文档

大雄 1277 2022-08-27


下面是关于在线接口文档-在线接口文档管理工具

易文档

英文名叫easydoc，是新出来的文档管理平台，跟市面的那些有所不同，这个不管是编写体验还是预览，专业性和美观性都会大大超越其他的。




看下他的预览效果：




市面很多http接口文档的编写都是直接写markdown文档，这种编写起来特别麻烦。易文档在http文档方面有做专门的处理，做了很多优化体验，比如按tab就可以自动下一个输入框，可以保存一些常用的参数，方便快速引用进来，还有不限层次的子参数，参数行顺序调整。




特别强大的是，他的http文档可以自定义参数块和描述块，比如失败和成功返回的参数不一样，我们可以添加两个参数块，分别对应成功响应参数、失败响应参数




如果你想给每个返回都提供一个示例或者说明，也都没问题，可以自己添加描述块。而且块的顺序是可以调整的，非常方便。


 

修订历史

日期版本描述作者
2019-05-281.0
Yixun

目录

HTTP接口文档修订历史目录1. 用户提交1.1 接口公共参数说明1.2 接口通用返回值说明1.2.1 返回参数2.个性（批量）短信提交2.1 用户2.1.1 用户批量提交2.1.2 获取状态报告2.1.3 获取上行信息2.1.4 获取余额3. 附录3.1 提交响应错误码3.2 状态报告错误码

1. 用户提交

1.1 接口公共参数说明

参数名称参数类型是否必须参数描述
appIdString是用户Appid
timestampString是14位-当前时间戳 格式：yyyyMMddHHmmss
signString是32位-签名 格式：md5(appId+ secretKey +timestamp)
mobilesString是手机号（多个，用逗号分隔，最多1000个）
contentString是短信内容采用utf-8URLEncoder.encode(content, "UTF-8")
schTimeString否定时发送时间（选填，定时时间在90天内）格式：yyyyMMddHHmmss 14位 如果不填，则为即时发送
batchIdString是自定义消息ID（最长64位）
addserialString否扩展码，最长支持12位，如果超过，则会截取。根据我司建议位数提交

请求示例

http://ip:port/sms/sendBatch?appId=LHW-SMS-2XG&sign=e0be54f095fc72ee82a70dae644e7a0&mobiles=13000000000,15000000000&content=%E3%80%90%E9%B8%BF%E8%81%94%E4%B9%9D%E4%BA%94%E3%80%91%E6%82%A8%E5%A5%BD%EF%BC%8C%E6%82%A8%E7%9A%84%E9%AA%8C%E8%AF%81%E7%A0%81%E6%98%AF252111&timestamp=20190409153345&schTime=&batchId=101&addserial=3

 

1.2 接口通用返回值说明

1.2.1 返回参数

参数名称参数类型参数描述示例值
codeString值为 SUCCESS 时说明提交成功详细见响应示例
dataString结果内容 json格式

响应示例

{   "code": "SUCCESS",   "data": ""}

 

##

 

 

2.个性（批量）短信提交

2.1 用户

2.1.1 用户批量提交

接口说明

如需要大批量发送个性短信，减少HTTP请求次数，时间，可用此接口进行发送。可定时发送，定时本批提交的所有的个性短信的发送时间

URL

http://sms.51yixun.com:8200/sms/send

请求方式

get

参数请求格式

url

请求参数

参数名称参数类型是否必须参数描述
appIdString是用户Appid
signString是签名格式：md5(appId+ secretKey + timestamp) 32位
【手机号与内容】String是手机号=内容(必填)【可多个】，每次提交最多1000个以手机号为参数名，内容为参数值传输 如：18001000000=端午节快乐
schTimeString否定时发送时间(选填，定时时间在90天之内)格式:yyyyMMddHHmmss 14位 如果不填，则为即时发送
batchIdString是自定义消息ID（最长64位）
addserialString否扩展码，最长支持12位，如果最终号码长度超长，会截取扩展码，请根据我司建议位数提交

请求示例

http://ip:port/sms/send?appId=LHW-SMS-1LL&timestamp=20190409170903&sign=5063d9ecad6559113a8a385dda985d4&batchId=121121&addserial=001&13000000000=%E3%80%90%E8%81%94%E5%90%88%E3%80%91%E6%82%A8%E7%9A%84%E9%AA%8C%E8%AF%81%E7%A0%

返回参数

参数名称参数类型参数描述示例值
codeString值为 SUCCESS 时说明提交成功详细见响应示例
dataString结果内容 json格式




响应示例

{   "code": "SUCCESS",   "data": ""}

异常示例

{   "code": "SUCCESS",   "data": ""}

返回码说明

返回码返回码明细返回码描述



详细参考附录中全局返回码

备注

无

 

2.1.2 获取状态报告

接口说明

用于用户批量提交

URL

http://sms.51yixun.com:8200/sms/report

请求方式

get

参数请求格式

url

请求参数

参数名称参数类型是否必须参数描述
appIdString是用户appId
timestampString是时间戳 格式：yyyyMMddHHmmss
signString是签名 格式: md5(appId+ secretKey+ timestamp) 32位
numberint否获取数量 最多500个，默认是500个

请求示例

http://ip:port/sms/report?appId=LHW-SMS-2FG&sign=e0be54f095fc72ebea70dae644e7a0&timestamp=20190409153345

返回参数

参数名称参数类型参数描述示例值
codeString值为 SUCCESS 时说明提交成功详细见响应示例
dataString结果内容 json格式




响应示例：请求后有可返回的状态报告时：

{   "code": "SUCCESS",   "data": [       {"batchId":"101",        "state":"DELIVRD",        "desc":"成功",        "mobile":"15000000000",        "receiveTime":"2019-04-09 15:34:01",        "submitTime":"2019-04-09 15:32:30",        "addserial":"3"},       {"batchId":"101",        "state":"DELIVRD",        "desc":"成功",        "mobile":"13000000000",        "receiveTime":"2019-04-09 15:34:01",        "submitTime":"2019-04-09 15:32:30",        "addserial":"3"}]}

异常示例:请求后没有可返回的状态报告

{   "code": "SUCCESS",   "data": ""}

返回码说明

返回码返回码描述
batchId用户自定义消息批次id,用于匹配状态报告
state短信状态值，DELIVRD、0是成功
desc注释
mobile手机号
receiveTime接收时间
submitTime用户提交时间
addserial用户提交的扩展码

详细参考附录中全局返回码

备注

无

 

2.1.3 获取上行信息

接口说明

用于用户获取上行

URL

http://sms.51yixun.com:8200/sms/mo

请求方式

get

参数请求格式

url

请求参数

参数名称参数类型是否必须参数描述
appIdString是用户Appid
timestampString是时间戳 格式:yyyyMMddHHmmss 14位
signString是签名 格式：md5(appId+ secretKey+ timestamp) 32位
numberint否获取数量，最多500个，默认500

请求示例

http://ip:port/sms/mo?appId=LHW-SMS-2XG&sign=e0be54f095fc72ebe82a70dae44e7a0&timestamp=20190409153345

返回参数

参数名称参数类型参数描述示例值
codeString值为 SUCCESS 时说明提交成功详细见响应示例
dataString结果内容 json格式




响应示例：请求后有可返回的上行信息时

{   "code": "SUCCESS",   "data": [{                         "mobile":"18313086061",          "addserial":"3",             "content":"收到，谢谢",                "moTime":"2019-04-09 15:34:01"            }]}

异常示例:请求后没有可返回的上行信息时：

{   "code": "SUCCESS",   "data": ""}

返回码说明

返回码返回码描述
mobile手机号
addserial用户扩展码
content上行短信内容
moTime上行时间

详细参考附录中全局返回码

备注

无

 

2.1.4 获取余额

接口说明

用于用户获取余额

URL

http://sms.51yixun.com:8200/sms/balance

请求方式

get

参数请求格式

url

请求参数

参数名称参数类型是否必须参数描述
appIdString是用户Appid
timestampString是时间戳 格式：yyyyMMddHHmmss 14位
signString是签名 格式：md5(appId+ secretKey+ timestamp) 32位

请求示例

http://ip:port/sms/balance?appId=LHW-SMS-2XG&sign=e0be54f095febe82a70dae644e7a0&timestamp=20190409153345

返回参数

参数名称参数类型参数描述示例值
codeString值为 SUCCESS 时说明提交成功详细见响应示例
dataString结果内容 json格式




响应示例

{   "code": "SUCCESS",   "data":          ｛         "balance":999       ｝}

 

返回码说明

返回码返回码描述
balance账号剩余余额，短信条数

详细参考附录中全局返回码

备注

无

 

 

3. 附录

3.1 提交响应错误码

参数名称描述
SUCCESS成功
APPID_ERROR请求APPID错误
PARAMS_ERROR请求参数错误
IP_ERROR不识别的IP
SPEED_ERROR请求超速
MOBILE_ERROR手机号为空、号码数量过多、手机号码错误
CONTENT_ERROR短信内容错误，空或过长
SCHTIME_ERROR定时时间过早或过久
BATCHID_ERROR缺少自定义消息id、自定义消息ID过长
EXTCODE_ERROR扩展码错误
BALANCE_ERROR余额不足
TIMESTAMP_ERROR时间戳错误
SIGN_ERROR签名错误

3.2 状态报告错误码

返回码返回码明细
DELIVRD成功
TIMEOUT运营商状态报告超时
FAIL_BALANCE余额不足
FAIL_MOBILE手机号错误、手机号不支持
FAIL_MOBILE_EM手机号重复
FAIL_AUDIT审核拒绝
FAIL_BLACK黑名单失败
FAIL_KEYWORD关键字失败
FAIL_TD用户退订
FAIL_WHITE白名单失败
FAIL_REJECTD拦截失败
FAIL_SIGN签名错误
FAIL_SPEED发送频率过快
FAIL_RESPONSE运营商响应失败
FAIL_UNKNOW未知失败

以上就是小编为大家整理的在线接口文档-在线接口文档管理工具


版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。

标签：在线接口文档管理工具
上一篇:Python turtle库详解（python编程）
下一篇:没有接口文档怎么开展接口测试？教你写接口需求文档
相关文章

 发表评论

评论列表

Eone @回复
2022-10-11 12:11:54

感谢作者推荐的在线接口文档管理工具，都是比较有知名度的工具，收藏了！

梅梅 @回复
2022-10-11 18:07:31

收藏下，万一以后刚好有需要，这里面说到的接口文档管理工具有些还是有听到过的。

Aicy @回复
2022-10-11 19:54:00

确实是该需要引进接口文档管理工具了，感谢作者的分享~

Nineo @回复
2022-10-12 14:45:36

这个http接口文说得比较深入，但是也好理解

李先生 @回复
2022-10-13 13:36:01

一直在找关于在线接口文档的介绍，学习到了！

Lucyer @回复
2022-10-13 13:44:09

学习接口文档的朋友可以使用国产的在线接口文档工具eolinker，简单易学是一款很容易上手的工具。

好学明月 @回复
2022-10-13 13:45:14

赞，很好的文章，详细的不能再详细了，感谢作者！

Blion @回复
2022-10-14 14:26:51

了解到了一些新的关于在线接口文档的知识，感谢作者分享

马同学 @回复
2022-10-18 11:52:26

很不错的文章，受益颇多，谢谢作者分享的关于在线接口文档的知识！

林同学 @回复
2022-10-18 16:11:00

我们自己用的是eolinker这个在线接口文档管理工具，感觉也是非常好用的！

Lost @回复
2022-10-18 16:12:28

最近听说有一个国产的在线接口文档工具叫做eolink，作者可以分享一下吗？

Cossi @回复
2022-10-19 16:19:43

支持作者推荐的在线接口文档管理工具，我们团队之前都没有用，效率比较低，现在用起来了后好处多多！

倪倪 @回复
2022-10-19 16:53:13

最近比较火的好像是一款国产的在线接口文档工具，名字好像是eolink

王先生 @回复
2022-10-19 16:54:20

感谢作者的分享，受益匪浅

归来 @回复
2022-10-20 14:03:09

我们自己用的是eolink这个在线接口文档管理工具，感觉用起来还是比较OK的

程祥 @回复
2022-10-20 14:04:15

正好在找关于在线接口相关的内容，学习到了