使用http://rap2.taobao.org/写测试接口文档

下面以设计评论接口为例，简单说明接口文档应该如何撰写。

首先，我们可以定义全局返回状态码。

返回码	返回信息	说明
10000	获取评论成功
10001	创建评论成功
10002	⽆无法创建评论	创建评论时因违反审核机制⽽而⽆无法创建
10003	评论已被删除	查看评论时评论因不不和谐因素已被删除

获取文章评论。

GET /articles/{article-id}/comments/
开发者:王勤勤
最后更新时间:2018年年8月10⽇
标签:v 1.0
接⼝说明:获取指定文章的所有评论

使用帮助:默认返回20条数据，需要在请求头中设置身份标识(key)

请求参数:

参数名	类型	是否必填	参数位置	说明
page	整数	否	查询参数	⻚页码，默认值1
size	整数	否	查询参数	每次获取评论数量量(10~100)，默认值20
key	字符串	是	请求头	用户的身份标识

响应信息：

{"code": "10000","message": "获取评论成功","page": 1,"size": 20,"totalpage": 35,"contents": [{"userId": "375188","userName": "刘益","pubData": "2018年8月2日","content": "楼上说的对"},{"userId": "820647","userName": "刘凯","pubData": "2018年4月1日","content": "楼上说的对"},"items": [1,true,"hello","VQcoWC2P1Z"],"object": {"foo": 1,"bar": "★★★★"},"placeholder": "Hdknfjx Qgqf Ccphzclv Qaiaf Erwnsdde Mqxnuukeis Wyxerxtuo"
}

点击导出

点击第一个链接下载，在postman中导入，然后就可以测试了。

在rap2设置数据返回格式

也可以在线直接看到数据样式

使用http://rap2.taobao.org/写测试接口文档相关推荐

分享一个强大的在线写API接口文档的工具showdoc
网站地址:https://www.showdoc.cc 第一步:注册第二步:填写注册信息,这里填写用户名和密码即可,用户名不可重复,注册登录后可以绑定邮箱. 也可以不注册查看示例决定要不要使用这个网 ...
接口文档包含哪些内容？怎么才能写好接口文档？十年测试老司机来告诉你
目录接口文档结构参数说明示例错误码说明语言基调通俗易懂及时更新与维护总结那么我们该如何写好一份优秀的接口文档呢? 接口文档结构首先我们要知道文档结构是什么样子的.接口文档应该有清晰明 ...
没有required_springboot-使用OpenAPI之后我再也没有写过接口文档
一前言这篇文章主要是带大家入门下如何使用OpenAPI, 笔者在github上找到对应得swagger项目都没找到javase得人门文章,看了下是基于JAX-RS,吐血了: 二什么是 OpenA ...
java如何写安卓接口文档_android、java制作sdk以及自动生成文档
最近一直在做android开发,昨天经理让我写个接口SDK做个接口文档,以便后面的开发. 这让我很焦灼,SDK怎么做?要是只有敲代码还好.可是那个接口文档!!!文档这东西最讨厌了,头都大了后来查了下 ...
flasgger手写phpwind接口文档
提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档目录前言一.flasgger是什么二.使用步骤 1.引入库 2.创建app 3.每个接口写yml文件三..结果预览总结前言 ...
apidoc写php接口文档
1.apidoc需要node.js支持,需要安装node.js 2.通过npm安装apidoc npm install apidoc -g 3. 在项目目录里面创建apidoc相关信息,一般是放根目录 ...
Apizza--编写Websocket接口文档
使用Websocket文档 1. 什么是websocket? WebSocket 协议在2008年诞生,2011年成为国际标准.所有浏览器都已经支持了. 它的最大特点就是,服务器可以主动向客户端推送信 ...
用蚕茧表示法写简洁实用的接口文档
蚕茧表示法是一个接口描述的规范.我用它的一个典型的场景就是写内部接口文档.蚕茧法体现了两个思想: 使用简洁的语法来描述对象.数组.字典等复杂结构. 通过命名规范,让一个名字自发地体现出它的类型.如名词 ...
DRF 自动生成接口文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
接口文档——Swagger
Swagger 接口文档对于前后端开发人员都十分重要.尤其近几年流行前后端分离后接口文档又变成重中之重.接口文档固然重要,但是由于项目周期等原因后端人员经常出现无法及时更新,导致前端人员抱怨接口 ...

使用http://rap2.taobao.org/写测试接口文档

使用http://rap2.taobao.org/写测试接口文档相关推荐

最新文章

热门文章