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