SpringBoot(28)Swagger注解，分组以及基本功能使用

1.注解

简单来说就是给实体类与接口中进行注释，让前后端人员测试能清楚知道方法作用，方便测试。

//接口
 @ApiOperation("Post请求")
    @PostMapping("/user/{username}/{password}")
    public User user(@PathVariable("username") String username,@PathVariable("password") String password){
        User user = new User();
        user.setPassword(password);
        user.setUsername(username);
        return user;
    }
//实体类
@ApiModel("用户实体类")
public class User {

    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;

2.分组

后端项目进行分工合作，实行分组能在swagger-ui界面中查看不同的人实现的不同功能。

分组：a ,b,c,lq

 @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，生产环境不使用
    @Bean
    public Docket docket(Environment environment){

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


        return  new Docket(DocumentationType.SWAGGER_2)
                .groupName("刘q")
                .apiInfo(apinfo())
                .enable(flag)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.qing.swaggerdemo.controller"))
                .build();
    }

查看分组
a:

3.基本功能的使用

比如后端实现了一个接口功能

  @ApiOperation("Post请求")
    @PostMapping("/user/{username}/{password}")
    public User user(@PathVariable("username") String username,@PathVariable("password") String password){
        User user = new User();
        user.setPassword(password);
        user.setUsername(username);
        return user;
    }

前端人员只需要登录swagger-ui,在其中测试我们方法，即可实现前后端的及时交互。