当前位置：首页 > news >正文

SpringDoc集成到Springboot

news 2025/6/12 17:30:17

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 {@Beanpublic 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 # 按字母顺序排序 API