使用 Smart-doc 记录 Spring REST API

    如果您正在使用 Spring Boot 开发 RESTful API，您希望让其他开发人员尽可能容易地理解和使用您的 API。文档是必不可少的，因为它为将来的更新提供了参考，并帮助其他开发人员与您的 API 集成。很长一段时间以来，记录 REST API 的方法是使用 Swagger，这是一个开源软件框架，使开发人员能够设计、构建、记录和使用 RESTful Web 服务。2018 年，为了解决与 Swagger 等传统 API 文档工具相关的代码侵入性和依赖性问题，我们开发并将其开源给社区。smart-doc

在本文中，我们将探讨如何使用 Spring Boot REST API 生成文档。Smart-doc

什么是 Smart-doc？

    Smart-doc是 Java 项目的接口文档生成工具。它主要从 Java 源代码中分析和提取注释以生成 API 文档。Smart-doc 扫描代码中的标准 Java 注释，无需像 Swagger 中使用的注释那样进行专门的注释，从而保持代码的简单性和非侵入性。它支持多种格式的文档输出，包括 、 、 、 等。这种灵活性允许开发人员根据自己的需要选择适当的文档格式。此外，Smart-doc 可以扫描代码以生成 JMeter 性能测试脚本。MarkdownHTML5Postman CollectionOpenAPI 3.0

更多功能请参考官方文档。

使用 Smart-doc 记录 API 的步骤

第 1 步：Maven 项目

• 使用最新版本的 Spring Boot 创建 Maven 项目

• 将 Web 依赖项添加到项目

第 2 步：将 Smart-doc 添加到项目中

• 添加到项目的smart-doc-maven-pluginpom.xml

XML格式

<plugin>
     <groupId>com.ly.smart-doc</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>[latest version]</version>
     <configuration>
         <configFile>./src/main/res