初识Swagger之SpringBoot集成Swagger2

初识Swagger之SpringBoot集成Swagger2

• 去maven查找相关依赖，搜索springfox:swag

• 找到Springfox Swagger2和Springfox Swagger UI两个依赖，选择最新版本导入

    <!--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>
  

• 第一次开启Swagger2

  @Configuration
    @EnableSwagger2 // 开启Swagger2
    public class SwaggerConfig {
        
    }
  

• 访问http://localhost:8080/swagger-ui.html

• 配置Swagger2

    @Configuration
    @EnableSwagger2 // 开启Swagger2
    public class SwaggerConfig {
        @Bean
        public Docket docket() {
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
        }
  
        //配置文档信息
        private ApiInfo apiInfo() {
            Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
            return new ApiInfo(
                    "Swagger学习", // 标题
                    "学习演示如何配置Swagger", // 描述
                    "v1.0", // 版本
                    "http://terms.service.url/组织链接", // 组织链接
                    contact, // 联系人信息
                    "Apach 2.0 许可", // 许可
                    "许可链接", // 许可连接
                    new ArrayList<>()// 扩展
            );
        }
  
    }
  

---

总结：

• 在线测试工具
• 通过Swagger给一些比较难理解的属性或者接口增添注释信息
• 接口文档实时更新
• Swagger是一个非常优秀的测试工具，在软件发布时，请务必关闭Swagger