接口测试中的文档规范

背景：
我们在企业做接口测试时，如果不清楚前后端的定义是怎么样的，返回类型是怎么样的，每个字段代表的意义是怎么样，那么开展接口测试的效率和质量就会很差，所以我们迫切需要有一个规范化的文档，这样会更加便捷和高效！

接口名称：
【评论列表接口】

https://api.weibo.com/2/comments/by_me.json
1.接口说明

获前登录用户所发出的评论列表
2.接口应用

4.支持格式
JSON

5.HTTP请求方式
GET

6.是否需要登录
是

7.请求参数

8.调用示例
https://api.weibo.com/2/comments/by_me.json? since_id =0& max_id =0& page =1& count =20& filter_by_source =1

9.输出参数

10.返回结果

10.1正确实例
Return JSON


10.2返回为空实例

Return JSON

10.3返回错误实例
Return JSON

错误代码

11.其他
无