前言
之前常用的SpringFox在2020年停止更新了，新項(xiàng)目集成SpringFox出來一堆問題，所以打算使用更活躍的SpringDoc，這里簡(jiǎn)單介紹一下我這邊SpringBoot2.6.6集成SpringDoc1.6.9的demo。
一、SpringDoc是什么？
官網(wǎng)鏈接
二、使用步驟
1.引入庫
maven為例：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.9</version>
</dependency>
2.配置類
代碼如下（示例）：
package com.yhcookie.demo.config;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* OpenAPI swagger 配置
*
* @author yhcookie
* @date 2023-08-25
*/
@Configuration
public class OpenApiConfig {
/**
* 配置API信息
* @return
*/
@Bean
public OpenAPI demoOpenAPI() {
return new OpenAPI()
.info(new Info()
.title("YHCookie API")
.description("springDoc demo API")
.version("v1.0.0")
// 若想增加其他API信息項(xiàng)，可參考官網(wǎng)
);
}
/**
* 配置過濾規(guī)則
* 若不配置該GroupedOpenApi, 默認(rèn)掃描所有接口并生成文檔
* @return
*/
@Bean
public GroupedOpenApi demoGroupedOpenApi() {
return GroupedOpenApi.builder()
.group("group1") // 分組名，可建多個(gè)不同分組，分別掃描不同位置接口
.pathsToMatch("/controller1/**")
// 接口過濾，據(jù)此增加接口掃描規(guī)則（掃描@Operation注解標(biāo)注的接口）。想皮一下的話，亦可自定義注解
.addOpenApiMethodFilter(method -> method.isAnnotationPresent(Operation.class))
.build();
}
}
3.訪問測(cè)試
默認(rèn)路徑：
UI界面 http://localhost:9527/swagger-ui/index.html
json界面 http://localhost:9527/v3/api-docs
UI的展示其實(shí)就是讀取該json展示的
總結(jié)
我這邊也是剛用不久，使用中有問題可以在這交流一下。文章來源：http://www.zghlxwxcb.cn/news/detail-705085.html
其他配置
# 是否啟用（默認(rèn)啟用，生產(chǎn)可配置false關(guān)閉）
springdoc.swagger-ui.enabled=true
# UI界面
springdoc.swagger-ui.path=/swagger-ui.html
立個(gè)Flag
翻譯一下官方文檔…文章來源地址http://www.zghlxwxcb.cn/news/detail-705085.html
到了這里，關(guān)于【Spring Boot】SpringBoot 2.6.6 集成 SpringDoc 1.6.9 生成swagger接口文檔的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
