什么是 API
API 全称为应用程序编程接口,通俗来讲就是不需要访问程序的源代码,也不需要理解程序实现的方式,只需要通过访问相应接口的 URL 并填写需要获得的数据的参数名,来获取需要的参数信息。
一个接口可以是一个简单的应用程序,例如电商平台、快递查询、手机归属地查询等等,这些都可以是接口,并且可以直接填写参数取值。
API 包含什么
每个 API 必须包含的参数:
1、API 名称
2、API 地址
3、API 的请求方法:POST、GET、HEAD、OPTIONS 等。
4、请求参数:请求头部、请求体(FROM-DATA、JSON、XML、RAW 等)Query 参数、REST 参数
5、响应内容:返回头部、返回结果
为什么需要管理 API
为什么要进行 API 管理呢?首先上述 API 所包含的只是单一的 API 所需的,当一个企业或者团队开发一个项目时 API 还包括:1、协议:HTTP、HTTPS、TCP、UDP 等,2、环境(域名):正式环境、测试环境,3、路径规则:设计路径规则,4、版本控制。再细分还包括 API 文档中的参数说明,状态码说明等。
管理 API 文档的好处除了能够快速的对 API 进行设计,也方便测试人员查看 API 的用法,更有利于人员流动进行快速交接。API 文档管理可谓是贯穿整个 API 的生命周期
API 管理平台
API 管理平台结合了线上线下文档的优点,弥补了不足。如 SWAGGER、EOLINKER 等,这些管理平台能满足管理 API 所需要的所有条件。