swagger配置在正式环境中不可访问swagger-ui.html

最新推荐文章于 2024-08-26 14:39:50 发布

万汉龙

最新推荐文章于 2024-08-26 14:39:50 发布

阅读量9.9k

点赞数

分类专栏：疑难杂症解决方案

本文链接：https://blog.csdn.net/cold_long/article/details/101010526

版权

这篇博客主要介绍了如何在Spring Boot应用中配置Swagger2，并通过条件注解`@ConditionalOnProperty`和配置文件控制在测试环境中暴露接口。同时展示了如何定义全局参数，以及使用`Docket`创建RESTful API的详细配置。`@ApiInfo`用于设置API的基本信息，如标题、描述和版本。注意，在正式环境中，Swagger UI默认被禁用以保护接口安全。

摘要由CSDN通过智能技术生成

@Profile("test")//配置只允许在测试的时候暴露所有的接

@Configuration
@EnableSwagger2
@ConditionalOnProperty(prefix = "swagger",value = {"enabled"},havingValue = "true")
@Profile("test")//配置只允许在测试的时候暴露所有的接口
public class Swagger2 extends WebMvcConfigurerAdapter {

    /*  @Api：修饰整个类，描述Controller的作用
        @ApiOperation：描述一个类的一个方法，或者说一个接口
        @ApiParam：单个参数描述
        @ApiModel：用对象来接收参数
        @ApiProperty：用对象接收参数时，描述对象的一个字段
        @ApiResponse：HTTP响应其中1个描述
        @ApiResponses：HTTP响应整体描述
        @ApiIgnore：使用该注解忽略这个API
        @ApiError ：发生错误返回的信息
        @ApiParamImplicitL：一个请求参数
        @ApiParamsImplicit 多个请求参数
    */
    @Bean
    public Docket createRestApi() {
        ParameterBuilder parameterBuilder