一些刚开始写接口文档的服务端同学,很容易按着代码的思路去编写接口文档,这让客户端同学或者是服务对接方技术人员经常吐槽,看不懂接口文档。这篇文章提供一个常规接口文档的编写方法,给大家参考。
成都创新互联提供成都做网站、成都网站建设、网页设计,品牌网站建设,1元广告等致力于企业网站建设与公司网站制作,10年的网站开发和建站经验,助力企业信息化建设,成功案例突破上1000+,是您实现网站建设的好选择.
推荐使用的是docway 写接口文档,方便保存和共享,支持导出PDF MARKDOWN,支持团队项目管理。
一、请求参数
1. 请求方法
GET
用于获取数据
POST
用于更新数据,可与PUT互换,语义上PUT支持幂等
PUT
用于新增数据,可与POST互换,语义上PUT支持幂等
DELETE
用于删除数据
其他
其他的请求方法在一般的接口中很少使用。如:PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数,称为地址参数,如**/user/{id}**,其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息,在接口文档中以K-V方式展示,其中Content-Type则是一个非常必要的header,它描述的请求体的数据类型。
常用的content-type:
application/x-www-form-urlencoded
请求参数使用“”符号连接。
application/json
内容为json格式
application/xml
内容为xml格式
multipart/form-data
内容为多个数据组成,有分隔符隔开
4. HTTP Body
描述http body,依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。
示例:
二、响应参数
1. 响应 HTTP Body
响应body同请求body一样,需要描述请清除数据的类型。
另外,如果服务会根据不同的http status code 返回不同的数据结构, 也需要针对不同的http status code对内容进行描述。
三、接口说明
说明接口的应用场景,特别的注意点,比如,接口是否幂等、处理是同步方式还是异步方式等。
四、示例
上个示例(重点都用红笔圈出来,记牢了):
五、接口工具
推荐使用的是(以前叫小幺鸡) 写接口文档,方便保存和共享,支持导出PDF MARKDOWN,支持团队项目管理。
淘宝的API有些是开放的,我查了一下所有类目的API是收费的,需要申请APIKey,然后调用对应查询接口,就能返回XML或JSON数据进行自己的处理了。
如果真是开发需要,就可以买淘宝的服务啊。
调用很简单,比如taobao.itemcats.get 接口(获取后台供卖家发布商品的标准商品类目),如下Java代码就返回结果了(前提是提供APIKey,需要申请审核)
TaobaoClient client=new DefaultTaobaoClient(url, appkey, secret);
ItemcatsGetRequest req=new ItemcatsGetRequest();
req.setFields("cid,parent_cid,name,is_parent");
req.setParentCid(50011999L);
req.setCids("18957,19562,");
ItemcatsGetResponse response = client.execute(req);
另外,变通的方法是自己开发爬虫,在淘宝页面上抓取,但问题是得不到淘宝技术支持,比如淘宝改版后也得跟着改动爬虫代码。
1、MESSAGE消息 1)头字段填写说明 Call-id: 必选 CSeq: 必选 From: 必选 To: 必选 Max-Forwards: 必选 Via: 必选 常用的可选参数: 指定的消息体 2)消息实例 发送MESSAGE请求消息给192.168.2.48的6010端口,
LZ去找些jsp的视屏看看吧 普通的功能很快就学会的 这些都是涉及到jdbc 还是自己敲敲吧