Swagger分组和接口注释[springboot15]

Swagger分组和接口注释

问题：如何配置多个分组？

• 多个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("注释")和//@Api("注释“)：用在实体类上
  

• @ApiModelProperty("注释")：用在实体类的字段上
  

• @ApiOperation("注释")：用在方法上
  @ApiParam("注释")  ：用在方法的参数上
  

项目结构：

pom.xml

<!--        swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

<!--        swagger-ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

<!--        web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

application.properties

# 应用名称
spring.application.name=demo-swagger
# 应用服务 WEB 访问端口
server.port=8080
spring.profiles.active=dev

application-dev.properties

server.port=8081

application-pro.properties

server.port=8082

SwaggerConfig.java

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

    @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");
    }


//    配置了swagger的Docket的bean实例
//enable():是否启用swagger,false不启用，true启用
    //groupName():组名
    @Bean
    public Docket docket(Environment environment){

        Profiles profiles = Profiles.of("dev", "test");
        boolean flag = environment.acceptsProfiles(profiles);

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

    //配置Swagger信息=apiInfo
    private ApiInfo apiInfo() {
//        作者信息
        Contact contact = new Contact("ws", "http://www.baidu.com", "248876078@qq.com");
        return new ApiInfo("诗若颜的API文档",
                "6666666",
                "v1.0",
                "http://www.baidu.com",
                contact,
                "Apache 2.0",
                "http://www.apach.org/licenses/LICENSE-2.0",
                new ArrayList<>()
                );
    }

}

HelloController.java

@RestController
public class HelloController {

    @GetMapping("hello")
    public String hello(){
        return "hello";
    }

    //只要我们的接口中，返回值存在实体类，它就会被扫描到Swagger中
    @PostMapping("/user")
    public User user(){
        return new User();
    }

    //ApiOperation接口不是放在类上，而是方法
    @ApiOperation("Hello控制类")
    @GetMapping("/hello2")
    public String hello2(@ApiParam("用户名")String name){
        return "hello" + name;
    }

}

User.java

//@Api("注释“) 等价 @ApiModel()
@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    public String name;
    @ApiModelProperty("密码")
    public String password;
}