API文档自动化
基于API驱动的开发模式具体到实际应用受到团队、人员、规模和管理流程等众多因素的影响。在敏捷开发实践中，一种理想的情况是开发人员在代码中描述API的详细信息，这些信息是整个开发跟踪的基准。借助于文档生成工具，自动提取API信息并生成文档。当代码产生变更时，通过CI/CD流程自动更新发布的API文档，让开发人员始终基于最新的接口进行开发，避免因沟通和跟踪问题导致开发效率低下甚至引入BUG。的准确性，完整性和及时性是影响开发效率的关键。
API描述文档有两种获取模式，一种是动态模式，可以根据运行的代码动态生成API描述，这对OpenAPI开放平台特别有用；另一种是静态模式，以HTML文档等形式展现。这两种模式都遵循一个原则：API描述信息的基准是源代码。多源头维护API描述的方式在实践中往往会产生不一致，滞后，最终会成为一种负担。
REST API
通过Swagger，ReDoc等工具，可以为REST风格的接口自动生成API接口描述，并依此生成清晰的API文档。Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。ReDoc是一款根据OpenAPI/Swagger生成的API接口描述文件生成API参考文档的工具。
遵循前述API描述信息的来源基准是源代码的原则，我们以Spring/Spring Boot/Spring Cloud项目作为实现API文档自动化的载体来探讨API接口描述的两种获取模式。