SpringDoc如何集成到Springboot
作者：MartinYangHJ
本文介绍了SpringDoc集成Spring Boot的步骤,包括Maven引入依赖、创建OpenApiConfig文件、配置application.yml及移除SpringFox依赖,以实现OpenAPI文档功能,感兴趣的朋友一起看看吧
1.Maven引入jar包
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.14</version>
</dependency>2.新建OpenApiConfig文件，代码如下
package com.elane.project.ztt.config;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
import io.swagger.v3.oas.annotations.security.SecurityScheme;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
//swagger显示Authorization
//@SecurityScheme(
// name = "bearerAuth", // 安全方案的唯一名称
// type = SecuritySchemeType.HTTP,
// scheme = "bearer",
// bearerFormat = "JWT" // 可选，表明 Token 格式为 JWT
//)
//将未登录header中的Authorization替换为sid
@SecurityScheme(
name = "sid",
type = SecuritySchemeType.APIKEY,
in = SecuritySchemeIn.HEADER,
paramName = "sid"
)
@Configuration
public class OpenApiConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info()
.title("API文档")
.version("1.0")
.description("API文档描述"))
.addSecurityItem(new SecurityRequirement().addList("sid"));
}
}3.application.yml文件增加如下配置
springdoc:
api-docs:
path: /v3/api-docs # 更改 API 文档路径
swagger-ui:
path: /swagger-ui.html # 更改 Swagger UI 路径
disable-swagger-default-url: true # 禁用默认 URL 加载
operations-sort-parameter: alpha # 按字母顺序排序 API4.注意
如果在项目中使用过SpringFox，需要将SpringFox的依赖全部移除
到此这篇关于SpringDoc如何集成到Springboot的文章就介绍到这了,更多相关SpringDoc集成Springboot内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！