Swagger2使用

1.在pom文件中进行配置

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

2.在config中开启swagger2

这就可以使用了。测试运行http://localhost:8080/swagger-ui.html

3.扫描配置及接口开关

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

    @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)
                .enable(flag)//enable 是否启动swagger,如果为false,则swagger不能在浏览器中访问
                //RequestHandlerSelectors 配置要扫描接口的方式
                //basePackage指定要扫描的包
                .select().apis(RequestHandlerSelectors.basePackage("com.xing.swagger.controller"))
                .build();
    }
}

4.分组
​

5.接口注释

在实体类中添加注释，当接口返回实体类时，会显示注释内容

页面测试接口显示实体类信息带有注释内容