应用API优先的方法意味着设计API，使其具有一致性和适应性，无论它们应用于哪个开发项目。为API使用API描述语言（如OpenAPI）是关键，因为它有助于建立API与其他程序通信的枢纽，即使这些系统各自的语言不同。当然，API并不是独立存在的，因此与利益相关者的协作和规划对于设计过程同样重要，设计过程早在实际编写任何代码之前就开始了。简而言之，在设计过程开始之前就需要决定实施API优先策略。为什么API优先设计很重要？传统上，一旦发现问题并且有人意识到新系统可以提供必要的解决方案，软件设计过程就开始了。一旦建立了大致的草图，下一步通常是更深入地挖掘以评估可能需要的任何用例以及正在创建的系统所需的交互形式。当然，所有这一切都必须在考虑用户体验(UX)的情况下完成，因为拥有一个有效的系统是不够的；它还需要对将要与之交互的开发人员和消费者友好，无论是在善后。端还在前端。有时问题甚至更简单，如果您有一个包含数据的内部应用程序，您希望通过API访问其他系统。但是，系统有自己的逻辑来告知其行为以及如何与他人交互。因此，您创建的任何API都将围绕这些功能和规则构建。一旦您的内部应用程序作为API的一部分连接起来，开发人员就可以与系统的内部结构进行交互并附加到它。如果那是您想要的，那可能没问题，但是如果您以后需要更改您的内部模型，就会出现问题。使用API优先方法进行设计意味着构建一个不仅仅是内部系统副产品的API。开发人员应该能够快速轻松地理解API的工作原理以及如何与其他应用程序集成。只有这样，他们才能编写出优雅的代码来有效地与其他系统进行交互，标准是当API正确运行时，它既向后兼容又向前扩展。API优先设计方式的优势1.开发团队可以并行工作签署协议可以让开发人员同时进行API开发的不同阶段，而无需等待应用程序更新所需的时间。因此，开发者可以按照预先制定的方案模拟API，有效测试任何相关参数项，无形中提高整体开发效率。2.降低开发应用程序的成本API优先设计方法的可重用性允许代码从一个项目转移到另一个项目，以便开发团队始终有一个基线架构可以使用。通过消除每次都从头开始编码的需要，任何相关的时间和财务成本也同样减少了。此外，开发人员无需创建任何新代码即可更快地解决API问题，从而实现与其他应用程序的更顺畅集成。3.加速发布启用自动化的“可视化”API使新手开发人员能够快速轻松地与API文档进行交互。事实上，很多API的构建过程都可以使用带有可视化API编辑器的工具实现自动化，可以导入API定义文件并自动生成文档，甚至可以模拟API的返回结果。这些工具大大减少了开发时间并提高了产品发布速度。最重要的是，通过API优先的方法，您仍然可以灵活地添加新的应用程序产品功能，而无需重新设计API架构。这是敏捷开发环境管理的明显优势，因此应用程序更新有望根据最终用户需求快速发布。4.改善开发人员体验开发人员每天都与API交互，因此创建提供积极开发人员体验(DX)的API至关重要。API优先的设计方法会导致API设计良好、文档完善且与其核心保持一致。开发人员可以使用API更轻松地与其他应用程序集成，快速解决出现的任何问题，甚至由于不太稳健的学习曲线而在更短的时间内找到其他开发人员。5.降低失败风险对于大多数企业而言，API是从营销和销售到代表其品牌的面向消费者的应用程序的一切开发环境的组成部分。API的任何部分出现故障都可能是毁灭性的。然而，由于设计和实现的固有可靠性、稳定性和一致性，采用API设计优先的方法大大降低了出错的可能性。应用程序集成背景下的API设计API为新旧系统之间的通信提供了统一的结构，允许转换数据传输。但API实施不仅仅是一个IT问题，API的设计必须考虑到整个组织的目标。通过将API策略置于设计过程的最前沿，可以改进系统之间的应用程序集成和互操作性，并在许多情况下进行优化。如果改变了，你仍然可以选择以其他方式发展。设计良好的API有哪些特点？最有效的API设计包括以下属性：1.易于阅读和使用：详细、全面和简洁的API文档易于阅读，并提供支持开发人员使用的简单示例。参考和参数非常直观，易于学习和记忆。2.不易被滥用：API的实现和集成方式容易区分，开发者即使在编写代码时也很难被滥用。它还包含信息反馈，同时允许开发人员具有相当程度的灵活性。3.完整简洁：API非常全面，开发者可以利用它沟通的数据，在可预见的未来逐步构建完整的应用。这种稳定的可用性和灵活性代表了每一个API创建者应该追求的设计理念。API-first设计的工具现在，有很多很多工具和标准可以支持API-first开发，比如EOLINKER、RAML和Swagger，它们都提供了优秀的编辑工具来支持API-first设计的策略。EOLINKER主要文档页面清晰，编辑逻辑简单，支持自定义MOCK测试，支持UI直观的自动化测试。也可以读取代码注释生成文档，Raml和Swagger页面也展示的不错，可以进行编辑、测试等基本功能，但与EOLINKER相比，在自动化测试功能方面略有不足，仅前者支持中文，后两者只支持英文。这些API编辑器可以轻松实现API版本控制，更容易在更短的时间内完成整个开发和测试过程。附上EOLINKER官网：https://www.eolinker.com附上Swagger官网：https://swagger.io/附上RAML官网：https://raml.org/FinalthoughtsAPIA优先级方法会对API使用产生巨大影响。如果您的API目标包括高使用率和保留率，或者为开发人员提供出色的开发人员体验，则尤其如此。最有效的API设计通过易于理解的内容和明确的目标导向提供直接的用户体验，从而实现快速集成和使用。同样，随着学习曲线的降低，API享有可重用性和持续的开发人员参与。参考：DavidBrown,ImplementinganAPI-FirstDesignMethodology原文地址：https://dzone.com/articles/im...
