如何简单的管理API

57 阅读2分钟

API本质上是封装和抽象功能的、并且只公开一个用于访问该功能的接口。API开发人员常常没有意识到其中有多少功能没有公开,这会让使用者无法更好的理解、使用API。

如果发布的API难以集成、不遵循任何标准或不适当的标准,则开发人员使用该系统会非常吃力。确定要使用哪种API标准非常重要,因为每种标准都针对特定的受众。如果需要支持最大数量的用户,可以使用一个非常简单的、不需要太多开销的API标准,例如RESTful API。REST标准相当宽松。最好的方法是各个API之间保持一致。

遵循用于身份验证的通用API标准(例如OpenID,OAuth和SAML)可以使开发人员和非开发人员客户更容易地使用API。但是,如果不为用户处理身份验证,请使用更简单的基于HTTP或基于令牌的身份验证,而不是主要用于身份验证的OpenID,OAuth或SAML。

此外,提供一个可记录自身信息的API文档,对开发人员来说是有益的,它可以让开发人员快速的了解API的作用。例如您可以将API规范等信息保存在Eolinker中。Eolinker是一个统一接口管理平台,可快速导入API并生成API文档。当API文档完善后,还需要围绕它们进行一些良好的测试。 使用地址:www.eolinker.com

如果你想让你的API易于使用和理解,你真的必须把它文档化。当API文档规范化且有较高的可读性,则API管理会变得更加简单,并大大提高工作效率。