springboot配置swagger(丝袜哥)生成api接口文档

ゞ浴缸里的玫瑰 2022-12-28 14:14 267阅读 0赞

前后端分离开发模式中，api文档是最好的沟通方式。  
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。  
及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)  
规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)  
一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)  
可测性 (直接在接口文档上进行测试，以方便理解业务)  
配置Swagger2  
**第一步导入依赖**

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <scope>provided </scope>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <scope>provided </scope>
            </dependency>

**第二步创建swagger的配置类**  
@EnableSwagger2不要忘记  
@EnableSwagger2不要忘记  
@EnableSwagger2不要忘记  
重要事情说三遍  
代码基本不用改，直接复制食用即可

@Configuration//配置类注解不要忘记
    @EnableSwagger2
    public class SwaggerConfig { 
    
        @Bean
        public Docket webApiConfig(){ 
    
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("webApi")
                    .apiInfo(webApiInfo())
                    .select()
                    .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                    .paths(Predicates.not(PathSelectors.regex("/error.*")))
                    .build();
    
        }
        
        private ApiInfo webApiInfo(){ 
    
            return new ApiInfoBuilder()
                    .title("网站-课程中心API文档")
                    .description("本文档描述了课程中心微服务接口定义")
                    .version("1.0")
                    .contact(new Contact("Helen", "http://atguigu.com", "55317332@qq.com"))
                    .build();
        }
    }

**第三步重启项目并访问**

http://localhost:8001/swagger-ui.html
    注意自己的项目信息及端口号自行修改

**四、接口文档显示出来**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0ODU1MTg4_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0ODU1MTg4_size_16_color_FFFFFF_t_70]: /images/20221120/b5315c60d50a4746bb7913f94d9c56dd.png