1.接口定义
接口API(Application Programming Interface,应用程序接口),是一个软件或服务对外提供的接口,别人只要调用这接口,而内部如何实现,不需要关心。你只要按照要求进行接口调用即可。
外部系统与系统之间以及内部各子系统之间的交互点。包括外部接口、内部接口。
2.作用
对于软件提供商来说,留出API,让别的应用程序来调用,软件才能发挥最大的价值,才能更有生命力。
对于应用开发者来说,有了开放的API,就可以直接调用多家公司做好的功能来做自己的应用,不需要所有的事情都自己操刀,节省精力。
3. 接口的表现形式
客户端要先操作服务端资源,首先要找到服务端提供的接口,然后才能向服务端发送资源请求 何为接口,比如:
http://www.qubaobei.com/ios/cf/dish_list.phpstage_id=1&limit=20&page= 1
- (http:)是采用的协议。这里的HTTP就是个协议 。
- (//www.qubaobei.com)是服务器地址 。以双斜杠“//”开头,后面跟的就是这个服务器的地址,专业术语叫域名。
- (/ios/cf/dish_list.php) 是请求资源路径。表示你要请求的资源在该服务器下/ios/cf/dish_list.php的路径下。
- (?stage_id=1&limit=20&page=1)是参数。参数可以找到具体内容,和路径之间使用“?”隔开,参数之间使用“&”隔开。参数是以键值对的形式表现出来的。
4.接口文档
接口文档展示
5.封皮
封面最好是本公司规定的封面,有logo,内容标题,版本号,公司名称,文档产生
日期。
6.修订历史
表格形式较好些。包括:
版本,修订说明,修订日期,修订人,审核时间,审核人。
7.接口信息
接口调用方式,是post方式还是get方式,接口地址,别人需要线上的哪个地址就写哪个。
8.功能描述
一定要清晰的描述接口功能。
9.接口参数说明
每个参数都要和实际中调用的一样,包括大小写;参数的含义言简意赅的说明;说明部分,说明参数值是需要哪个公司提供,并详细说明参数怎么生成的,例如时间戳,是哪个时间段的;参数是否必填,一些参数是必须要有的,有些是可选参数,一定要注意写清晰。
10. 返回值说明
1、有一个模板返回值,并说明每个返回参数的意义。
2、提供一个真实的调用接口,真实的返回值。
注:现实工作中,对接口有疑问要及时跟同事交流。