1 接口
1.1 接口概述
定义:接口就是API(Application Programming Interface,应用程序接口)
1.2 接口的表现形式
http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1
协议 主机地址 路径 参数
11.2 接口文档
11.2.1 封皮
封面最好是本公司规定的封面,有logo,内容标题,版本号,公司名称,文档产生
日期。(错误地方在于,文档的标题要和页眉中的标题一致)
11.2.2 修订历史
表格形式较好些。包括:
版本,修订说明,修订日期,修订人,审核时间,审核人。
11.2.3 接口信息
接口调用方式,是post方式还是get方式,接口地址,别人需要线上的哪个地址就写哪个。(自己提前测试好线上的这个接口,是否有其他问题,千万别犯低级的错误,尤其是某个字母写错)
11.2.4 功能描述
一定要清晰的描述接口功能。(不要遗漏一些细节,比如接口获取的信息不包括哪些,哪些要写明白)
11.2.5 接口参数说明
每个参数都要和实际中调用的一样,包括大小写;参数的含义言简意赅的说明;格式是string 还是int 还是long等格式(例如参数为@RequestParam("appKey") StringappKey, @RequestParam("randomId") Integer randomId);说明部分,说明参数值是需要哪个公司提供,并详细说明参数怎么生成的,例如时间戳,是哪个时间段的;参数是否必填,一些参数是必须要有的,有些是可选参数,一定要注意写清晰。
11.2.6 返回值说明
1、有一个模板返回值,并说明每个返回参数的意义。
2、提供一个真实的调用接口,真实的返回值。
注:现实工作中,对接口有疑问要及时跟同事交流。
2.1 postman简介
2.1.1 什么是Postman
2.2 Postman下载和安装
2.2.1 Postman的下载
官网下载: 地址:https://www.getpostman.com/