Springboot怎么配置Swagger2登錄密碼

本篇內容介紹了“Springboot怎么配置Swagger2登錄密碼”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

Swagger

Swagger是使用OpenAPI規范（OAS）開發API的最廣泛使用的工具生態系統。Swagger由開源和專業工具組成，滿足幾乎所有的需求和用例。

一、配置Swagger

添加依賴

// web依賴
<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
</dependency>

//swagger依賴
<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>

添加配置類

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("包名"))
                .paths(PathSelectors.any())
                .build();
    }

    public ApiInfo apiInfo()
    {
        return new ApiInfoBuilder()
                .title("接口")
                .description("接口說明")
                .version("1.0")
                .build();
    }
}

使用

// 控制層
@Api(tags = "基礎模塊")
@RestController
@RequestMapping("/base")
public class BaseController {
    
    @ApiOperation(value = "查詢")
    @RequestMapping(value = "/findList", method = RequestMethod.POST)
    public RestResponse findList(@RequestBody Param param)
    {
        return RestResponse.ok();
    }
}

訪問地址
localhost:8080/swagger-ui.html

將接口文檔暴露在外網會出現一定的安全問題，此時我們需要給Swagger文檔配置登錄密碼。

二、配置Swagger登錄密碼

添加依賴

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.3</version>
</dependency>

更新配置類

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI     //添加注解
public class SwaggerConfig {
}

添加啟動類注解

@EnableSwagger2

配置yaml文件

swagger:
  basic:
    enable: true     // 啟用
    username: 用戶名
    password: 密碼

“Springboot怎么配置Swagger2登錄密碼”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！