随着api设计规范的普及，我特地花时间整理了基于历史使用和最佳实践构建API的最佳方法。API描述格式可以作为用户可用的规范，来帮助理解如何最好地使用API。这个规范与计算机语言无关，人和计算机都可以阅读，可以帮助简化应用程序的抓取，和提高程序之间的可操作性。
设计优先与代码优先API开发
在使用API描述格式时，出现了两个重要的思想流派：API开发的“设计优先”和“代码优先”方法。
代码优先是构建API的一种传统的方法，在部署业务需求之后进行代码开发，最终通过代码生成文档。而设计优先提倡在编写任何代码之前先设计API的规范，这是一种这几年逐渐流行起来的新方法。
为了更好地理解这两种方法，让我们看看API生命周期的常见过程。和其他产品一样，API的概念始于业务团队识别一个机会。战略分析师和其他业务人员会分析机会，并在文本文档中创建利用机会的计划。然后将该文档传递给开发团队，在开发团队中，计划采取了一些具体的形式。从现在开始，开发API有两种可能：
设计第一：把计划转换成人和计算机都可读的规范，例如生成代码的Eolinker文档
代码优先：根据业务计划，直接编写API，从中生成人和计算机可读的接口文档，例如Eolinker自动生成文档
最后，在API运行之后，对其进行完整的测试，然后将其部署到合适的主机上。
这两种方法都有其优点和缺点，最终，选择正确的方法可以归结为您希望用API解决的当下的技术和战略需求。
设计优先——当开发人员的经验很重要的时候
一个设计良好的API可以为您的API的采用和使用带来奇迹，使用设计优先方法可以更好地实现良好的设计。如果您的API策略涉及高度采用API并保留与API的集成的用户，那么良好的开发人员体验非常重要。有效的API设计可以帮助最终用户快速理解API的资源和价值主张，从而减少他们与API集成所需的时间。当与API集成时，具有一致设计的API降低了学习曲线，使其更有可能具有更高的重用价值和参与度。Eolinker开放平台可以很好的帮助你做到这一点
应用场景
采用设计优先方法最多的情况是API的目标受众是外部客户或合作伙伴时。在这种情况下，API是一个关键的分发渠道，客户可以通过开放的接口来使用为他们提供的服务，而良好的设计在决定客户满意度方面起着关键作用。
这些API在代表组织的服务方面起着至关重要的作用，特别是在全渠道生态系统中，信息的一致性和不麻烦的消费是企业成功的一个重要指标。
代码优先——交付速度快的事项
如果开发人员直接从需求文档开始编写API，那么他们可以更快地实现API。如果您的市场策略强调速度和敏捷性是API程序成功的重要因素，这一点非常重要。在代码优先方法中自动化要容易得多，这有助于提高这种情况，许多库支持服务器代码、功能测试和部署自动化。
应用场景
代码优先方法以良好的开发经验为前提，提供了速度、自动化和降低流程复杂性的功能。如果API供只需要构建API的团队或公司内部使用，那么代码优先方法是一个理想的解决方案。所开发的API很小并且只有几个端点的情况，尤其如此。
总结
这两种方法都有好的一面，也有差的一面。开发API的方法将在确定如何使用和维护API方面发挥至关重要的作用。您的API的最终使用者是谁？他们有什么需要？你想用你的API程序来解决什么？在选择正确的API开发方法时，这些问题应该指导您的决策。