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
4.注意?
如果在項目中使用過SpringFox,需要將SpringFox的依賴全部移除?