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治理会变得更加简略,并大大提高工作效率。