标签：最终用户 Eolinker 开发人员 流程 API 设计 团队

良好的API设计被认为是API团队的“必备条件”。在当今的API经济中，API是业务战略的驱动力，API可用性正在增强从单片到微服务体系结构的过渡能力，优良的设计从未如此重要。

了解API设计

API设计意味着需要提供一个有效的接口，帮助API使用者（内部和外部）更好地了解、使用和集成，同时帮助自身有效地维护它。通常，设计良好的API应该是：

易于阅读和使用：设计良好的API易于使用，最终用户可以轻松理解API资源和相关操作。

难以滥用：以良好的设计实现API并集成到系统是一个简单的过程，编写不正确的代码的可能性较小。

完整且简洁： 完整的API使开发人员能够针对公开的数据制作功能完善的应用程序。

良好的API设计目标应是使最终用户在尽可能成功使用API。对于内部API，提高的可用性可以为通过API使用服务的开发人员提高生产率。在开发API后端并创建支持文档时，它也有助于实现更好的工作流。 对于面向外部的API，良好的API设计将提高用户的采用率，并让最终用户更容易地了解API所带来的价值。

Eolinker在API设计中的作用

对API设计的日益关注导致了API描述格式的大量采用，RESTful API的标准格式是OpenAPI规范。Eolinker提供了一种语言不无关的格式，用人和机器可读的方式描述API，自动构建漂亮的交互式API文档，同时在这个设计之上构建代码。当API文档准备就绪时，这个描述也可以用来为你的API构建测试用例。 为设计API提供一种人类可读的格式的好处是，整个团队（开发人员和非开发人员）以及最终用户都可以轻松了解API应该做什么，以及如何最好的使用API。Eolinker通过为团队提供一个关注点来，方便在开始编码之前对API的设计进行协作。

建立设计流程

如今，越来越多的API团队使用Eolinker工具来设计API。团队实施和维护API设计所遵循的流程根据几个因素而有所不同，这些因素包括：最终用户，API的数量以及API程序的战略和业务目标。对于那些刚刚开始设计API的团队来说，建立可扩展的API设计流程不是主要考虑因素。但是随着API程序的发展，可能会出现一些挑战。我们从团队中听到的一些最常见的设计挑战包括：
托管和维护API设计文件：许多团队将依赖于内部解决方案，或者像GitHub这样的源代码控制工具，这些工具是为存储代码而构建的，而不是设计文件。
处理API设计的版本控制：团队需要一个解决方案来处理多个API版本，并确保提供最新版本并在使用中。
跨团队迭代API设计：当不同的团队处理现有API的开发和文档时，处理现有API的设计变更至关重要。
设置和执行样式准则：如何确保团队遵循为内部和外部API设置的设计标准？
如需了解更多，可以访问：www.eolinker.com。

标签：最终用户,Eolinker,开发人员,流程,API,设计,团队
来源： https://www.cnblogs.com/dc20181010/p/14714932.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。