swagger添加访问密码

文章介绍了如何在项目上线后保护Swagger接口文档,避免直接暴露。通过在SpringBoot中引入相关依赖,配置application.yml文件以启用基本认证,并在Swagger配置类中进行设置,实现只有登录用户才能访问Swagger。同时提到了使用@Profile注解针对不同环境展示或隐藏Swagger。
摘要由CSDN通过智能技术生成

swagger现在是很普遍使用的接口文档。

但当项目发布到正式环境之后,swagger暴露给外部是很致命的,因此可以使用添加用户密码访问

(也可以设置swagger隐藏,利用@Profile对不同环境做不同操作,选择展示或者隐藏)

第一步:引入依赖


        <!-- swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
 
        <!--swaggerUI框架-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.4</version>
        </dependency>
        

第二步:编写application.yml文件

swagger:
  production: false
  basic:
    enable: true
    username: root
    password: test

切记swagger.production 不可设置为true,否则将屏蔽所有资源

第三步:编写swagger配置文件文件

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
/**
 * @author wsj
 * @Date 2019/8/20
 */
@EnableSwaggerBootstrapUI//(该注解swagger需要配置登录用户和密码才需要)
@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
 
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
//                .enable(isEnable)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.test.api"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("后台管理系统API")
                .termsOfServiceUrl("http://localhost:8899/")
                .version("1.0")
                .build();
    }
}
@EnableSwaggerBootstrapUI该注解正常使用swagger无需添加,需要用到登录访问时再添加。

如果没有这个注解,加密就不会生效!!!

以上就完成了。

Swagger未授权访问漏洞可以通过以下方法修复,并确保正常访问Swagger文档: 1. 禁用Swagger UI的默认URL路径:可以通过更改Swagger UI的URL路径来防止未经授权的访问。可以将Swagger UI的URL路径更改为一个不容易被猜测到的路径,例如将默认路径`/swagger-ui.html`更改为`/random-path/swagger-ui.html`。 2. 添加访问控制:可以通过在应用程序中添加访问控制来修复未授权访问漏洞。可以使用身份验证和授权机制来限制对Swagger UI的访问。例如,可以要求用户进行身份验证并授予访问Swagger UI的权限。 3. 使用安全代理或反向代理:可以使用安全代理或反向代理来保护Swagger UI免受未经授权的访问。安全代理可以拦截对Swagger UI的请求,并根据特定的访问规则进行验证和授权。 4. 配置Swagger文档的访问权限:可以通过配置Swagger文档的访问权限来修复未授权访问漏洞。可以将Swagger文档的访问权限设置为仅限于授权用户或特定IP地址。 5. 更新Swagger版本:如果发现Swagger存在已知的安全漏洞,可以尝试升级到最新版本的Swagger框架,以修复这些漏洞。 请注意,以上方法仅提供了一些常见的修复未授权访问漏洞的方法,具体的修复方法可能因项目的具体情况而有所不同。在实施任何修复方法之前,请确保对项目的影响进行充分评估,并遵循最佳实践和安全建议。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值