Swagger

Swagger简介

• 号称世界上最流行的Api框架
• RestFul Api文档在线自动生成工具=>Api文档与Api定义同步更新
• 直接运行，可以在线测试API接口
• 支持多种语言（java,php）
  官网：https://swagger.io/

1.在项目中使用Swagger需要springbox

• swagger2
• ui

springboot集成Swagger

1.新建一个springboot web项目
2.导入相关依赖

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

3.编写一个hello工程

@RestController
public class HelloController {
    @RequestMapping(value = "/hello")
    public String hello(){
       return "hello";
    }
}

4.配置swagger=>config

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

5.测试运行：
http://localhost:8080/swagger-ui.html

配置Swageer

Swagger的bean实例Docket

@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig {
    //配置了swagger的docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }
    //配置swagger信息=apiinfo
    private ApiInfo apiInfo(){
        //作者信息
       Contact contact= new Contact("秋红", "", "");
        return new ApiInfo(
                "swagger日记",
                "天生我材必有用",
                "1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<VendorExtension>());
    }
}

Swagger配置扫描接口

• Docket.select()

//配置了swagger的docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                //RequestHandlerSelectors配置要扫描接口的方式
                //basePackage:指定要扫描的包
                //any():扫描全部
                //none()都不扫描
                //withClassAnnotation:扫描类上的注解，参数是一个注解的反射对象
                //withMethodAnnotation:扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.nie.swagger.controller"))
                //paths:过滤什么路径
                .paths(PathSelectors.ant("/nie/**"))
                .build();
    }

配置是否启动swagger

//配置了swagger的docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(false)//enable是否启动swagger，如果为false，则swagger不能在浏览器中访问
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.nie.swagger.controller"))
                .build();
    }

1. 怎么在生产环境中使用，在发布的时候不使用？

• 判断是不是生产环境 flag=false
• 注入enable（flag）

@Bean
    public Docket docket(Environment environment){
        //设置要显示的swagger环境
        Profiles profiles=Profiles.of("dev","test");
        //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
        boolean flag=environment.acceptsProfiles(profiles);


        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(flag)//enable是否启动swagger，如果为false，则swagger不能在浏览器中访问
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.nie.swagger.controller"))
                .build();
    }

配置API文档的分组

.groupName(“秋红”)

• 如何配置多个分组，多个Docket实例即可

 @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("a");
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("b");
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("c");
    }

实体类配置

@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
}

• controller

@RestController
public class HelloController {
    @GetMapping(value = "/hello")
    public String hello(){
       return "hello";
    }

    //只要我们的接口中，返回值中存在实体类，就会被扫描到swagger中
    @PostMapping(value = "/user")
    public User user(){
        return new User();
    }
    //operation接口,不是放在类上的，是方法
    @ApiOperation("hello控制类")
    @GetMapping(value = "/hello2")
    public String hello2(@ApiParam("用户名") String username){
        return "hello"+username;
    }
}

总结

1. 我们可以通过swagger给一些比较难理解的属性或者接口，增加注释信息
2. 接口文档实时更新
3. 可以在线测试

• 在正式发布的时候，关闭swagger