从Web应用程序到挪动应用程序,API都是每个古代应用程序的骨干。它们是集成应用程序的要害,许多公司围绕着外围业务服务构建了数十个甚至数百个API。API治理平台将确保这些资源可能放慢交易和通信的速度,而不会使之成为治理上的麻烦。
为了帮忙开发团队治理API,公司能够思考应用API文档治理平台,甚至能够应用自动化的API测试和管理系统。利用市面上曾经成熟的治理平台如Eolinker、Swagger来帮助管理工作。
通常,良好的API治理可归结为三个根本工作:1、平安和认证2、监督和警报3、发现和文档
平安与认证
爱护API是一项重要的但常常被忽视的工作。大多数API将共享一个用于申请身份验证的通用办法。这可能是OAuth,JSON Web Token,或者仅仅是根本的API密钥身份验证。在某些状况下,API网关层将解决身份验证,只需将登录的任何用户或设施以及相应的权限传递给API。该API网关层通常会应用用户的申请来调用特定的身份验证API,以对其进行身份验证。
然而,须要特地留神的是,即便假如API位于API网关之后,它依然须要避免来自可信网关源的歹意API申请。通常,这是通过联合防火墙规定和拜访控制策略来实现的。应用AWS API Gateway,能够通过应用身份和拜访管理权限来解决此问题,并验证任何给定申请仅来自API网关,避免其余申请间接命中该API。
大多数云API治理平台都存在相似的身份验证办法。另外,验证这些平安实际也很重要,应该别离跟踪和监督每个API,以便定期测试破绽。
监控和警报
大多数API都依赖于内部连贯。身份验证API可能依赖于数据库,并且大多数API可能在一开始就依赖于身份验证API。
许多API工具平台都提供了某种模拟系统以及常见状态查看。至多,API网关反对监督故障事件。当呈现问题时,能够在客户开始埋怨之前告诉开发人员。API监控日志中提供的这些附加详细信息有助于确定API的哪个局部存在问题。
Mock API对于尚未拜访您的平台的开发人员十分有用。例如,一个新的开发人员可能在第一次开始与他们的应用程序构建集成时抉择应用Mock API,这不会对生产服务器造成任何压力。如果该开发人员证实该应用程序能够运行并且不会对您的基础设施造成不必要的压力,则能够抉择提供他生产凭证。
发现和文档
集中所有API并提供欠缺的文档,使团队、用户能够共享告诉。在小型团队中,询问其余团队是否有人已经开发过某个性能可能很容易。在具备简单应用程序的大型组织中,想要对API进行无效的治理,团队可能本人定位此类信息变得越来越重要。
就像GitHub能够很容易地确定是否有人曾经编写了一个开源我的项目来解决特定问题一样,集中式API文档治理平台能够帮忙开发团队确定公司中是否有人曾经解决了特定问题。不要反复编写雷同的API。
不同团队能够通过许多不同办法来记录API。例如,Eolinker不仅提供了提供Mock API,还能够显示示例申请类型、API残缺文档以及在线分享。开源团队常常依赖Github,因为它曾经成为人们解决问题时依赖的中央,并且内置了错误报告性能。
开发人员通常在小型团队中工作得最好,在单个团队中最多只能有五个人,而在那个团队中最多只能有几个相干我的项目。当API分为微服务并能够在多个团队之间共享时,不仅要记录如何应用API,还要记录领有该API的团队。
当公司倒退为蕴含数十个或数百个API时,任何人都能够为特定的API提供帮忙和奉献,但必须由专人负责保护完整性和稳定性。
本文借助Eolinker API管理工具进行展现。Eolinker是一个适配不同规模团队的Saas工具,同时也反对私有化部署。
应用地址:www.eolinker.com