Spring Boot 通过 Swagger 自动生成 ShowDoc 文档

配置Spring Boot 自动化文档提高开发效率

Spring Boot配置Swagger

1. pom.xml添加依赖

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>

2. 添加Swagger配置类

@Configuration //说明这是一个配置类
@EnableSwagger2// 该注解开启Swagger2的自动配置
public class SwaggerConfig {
}

3. 启动程序访问 http://localhost:8080/swagger-ui.html

集成ShowDoc

通过拉取 Swagger 的 JsonData 数据解析,调用ShowDoc文档API接口上传文档

获取Swagger JsonData

String jsonDoc = HttpHelper.doGet("http://localhost:8080/v2/api-docs");
Swagger swagger = (new Swagger20Parser()).parse(jsonDoc);

调用ShowDoc的API接口上传文档

String showDocApiUrl = http://127.0.0.1:80/server/index.php?s=/api/item/updateByApi
Map<String, String> parMap = new HashMap();
parMap.put("api_key", ApiKey);
parMap.put("api_token", ApiToken);
parMap.put("cat_name", "文件夹名称");
parMap.put("cat_name_sub", "子文件夹名称");
parMap.put("page_title", "文档标题");
parMap.put("page_content", "文档内容");
HttpHelper.doPost(showDocApiUrl, parMap);