API与API管理

原创
2020/11/25 18:22
阅读数 635

什么是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

1、OFFICE文档 OFFICE文档包括WORD、EXCEL等,使用OFFICE方便快捷,设置好规范即可使用,但不足的是维护API麻烦,且不能与团队实时分享。

2、在线文档 在线文档是线上版的OFFICE文档,例如腾讯文档、飞书等,这类产品虽然能弥补实时分享的问题,但还是不能解决维护的问题,团队协同性夜不高。

3、API管理平台 API管理平台结合了线上线下文档的优点,弥补了不足。如SWAGGER、EOLINKER等,这些管理平台能满足管理API所需要的所有条件外,一些专业的API管理平台(如EOLINKER)还提供了API自动化测试等强大功能。

结语

从API的介绍到API管理,在了解API的同时,可以对自己的团队或项目进行定位。如果只是需要对项目的API进行记录则可以以文档的方式记录API。但如果需要对API进行生命周期的管理,从API的设计开始,包括测试更新,直到弃用API,其中还需要进行团队协作等,在团队没有一个规范的流程能够满足以上需求的情况下,建议考虑使用API管理平台。

本文借助Eolinker API管理工具进行展示。Eolinker是一个适配不同规模团队的Saas工具,同时也支持私有化部署。 使用地址:www.eolinker.com

展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部