一、SpringBoot项目整合smart-doc接口文档管理插件 1、引入 smart-doc 插件 pom.xml <!-- 引入 smart-doc 插件 --><plugin><groupId>com.github.shalousun</groupId><artifactId>smart-doc-maven-plugin</artifactId><version>2.6.4</version><configuration><!-- 指定生成文档使用的配置文件 --><configFi...
在Spring Boot项目中整合smart-doc,可以按照以下步骤进行: 1. 理解smart-doc的功能及其与Spring Boot的集成方式 smart-doc是一款轻量级的API文档生成工具,支持从源代码注释中生成API文档。它可以通过Maven插件或Gradle插件的形式集成到Spring Boot项目中,以自动扫描项目中的Controller层代码和注释,生成相应的API文档。 2...
通过"createDebugPage": true 开启debug功能,在让生成smart-doc生成文档时直接放入到static/doc/下,这样可以直接启动程序访问页面http://localhost:8080/doc/index.html进行开发调试。 有的开发人员直接在idea中使用【Open In Browser】打开smart-doc生成的debug页面,如果非要这做,前端js请求后台接口时就出现了跨域。...
SpringBoot集成 smart-doc smart-doc支持多种方式生成接口文档:maven插件、gradle插件、单元测试(不推荐),这里我才用的是基于maven插件生成,步骤如下: 引入依赖,版本选择最新版本 <!--引入smart-doc--><plugin><groupId>com.github.shalousun</groupId><artifactId>smart-doc-maven-plugin</artifactId><version>...
你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。 2.1 特性 零注解、零学习成本、只需要写标准JAVA注释。 基于源代码接口定义自动推导,强大的返回结构推导。 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写...
从smart-doc 1.7.9开始官方提供了Maven插件,可以通过在项目中集成smart-doc的Maven插件,然后运行插件直接生成文档。 我们的案例基于smart-doc-maven-plugin,生成文档。示例参考官方配置文档而写。 配置 添加maven的插件 <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-...
在spring boot项目pom中添加smart-doc的maven插件 <plugin><groupId>com.github.shalousun</groupId><artifactId>smart-doc-maven-plugin</artifactId><version>[最新版本]</version><configuration><!--指定生成文档使用的配置文件--><configFile>./src/main/resources/smart-doc.json</configFile></configuratio...
spring-boot-web2(一个web测试模块,依赖common) Description smart-doc-maven-plugin多模块测试例子,本项目严格按照父子级来构建一个项目, spring-boot-web和spring-boot-web2两个web都需要依赖common模块,因此如果是直接用mvn命令 在spring-boot-web或者spring-boot-web2都是不能直接编译项目的,要想单独编译某一个...
[INFO] Smart-doc Start preparing sources at: 2022-07-01 22:43:54 [INFO] Artifacts that the current project depends on: ["org.springframework.boot:spring-boot-starter-web","org.springframework.boot:spring-boot-configuration-processor","org.projectlombok:lombok"] ...
1,基于maven项目来完成smart-doc接口文档的生成 在pom.xml文件添加插件依赖 <plugin> <groupId>com.github.shalousun</groupId> <artifactId>smart-doc-maven-plugin</artifactId> <version>2.0.1</version> <configuration> <!--指定生成文档使用的配置文件--> ...