Swagger接口文档配置

Love The Way You Lie 2023-10-03 10:47 26阅读 0赞

**配置文件**

/**
     * swagger配置
     */
    @EnableSwagger2
    @Configuration
    public class Swagger2Config {
    
        @Bean
        public Docket createReviewRestApi() {
            ArrayList<Parameter> params = Lists.newArrayList();
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).paths(PathSelectors.any()).build()
                .globalOperationParameters(Lists.newArrayList(
                    new ParameterBuilder().parameterType("header").name("at").description("访问令牌")
                        .modelRef(new ModelRef("string")).build())).globalResponseMessage(RequestMethod.GET, Lists
                    .newArrayList(
                        new ResponseMessage(HttpStatus.OK.value(), HttpStatus.OK.getReasonPhrase(), new ModelRef("string"),
                            new HashMap<>(), null))).globalResponseMessage(RequestMethod.POST, Lists.newArrayList(
                    new ResponseMessage(HttpStatus.OK.value(), HttpStatus.OK.getReasonPhrase(), new ModelRef("string"),
                        new HashMap<>(), null))).globalResponseMessage(RequestMethod.PUT, Lists.newArrayList(
                    new ResponseMessage(HttpStatus.OK.value(), HttpStatus.OK.getReasonPhrase(), new ModelRef("string"),
                        new HashMap<>(), null))).globalResponseMessage(RequestMethod.DELETE, Lists.newArrayList(
                    new ResponseMessage(HttpStatus.OK.value(), HttpStatus.OK.getReasonPhrase(), new ModelRef("string"),
                        new HashMap<>(), null))).globalOperationParameters(params).groupName("投资会议系统");
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder().title("投资会议系统接口文档").description("投资会议系统接口文档").version("1.0.0").build();
        }
    
    }

**swagger和UI模块依赖**

<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.3</version>
          </dependency>

效果图：  
（仅供参考！）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MTExNDIzNg_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MTExNDIzNg_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/556096eda9ee4813bb5beaff058bf83d.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl81MTExNDIzNg==,size_16,color_FFFFFF,t_70