分组和接口及小节

配置API分组

.groupName("蝶衣")

配置多个组，协同开发

可以看出groupName的类型是Docket，如果使用多个组，就要再创建一个Docket

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

添加User实体类，并加API注解

package com.example.demo.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;


@ApiModel("实体类User")  //给实体类添加注释
public class User {
    @ApiModelProperty("用户名")  //给属性添加注释
    private String username;
    @ApiModelProperty("密码")
    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

添加controller

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

在接口和参数上使用API(能不使用API就不使用，职责分明)

    @ApiOperation("用户控制类")
    @PostMapping(value = "/user2")
    public String user2(@ApiParam("用户名")String username){
        return "hello"+username;
    }

测试：Try it out

 @PostMapping(value = "/test")
    public User user2(User user){
        User user1 = new User();
        user1.setUsername(user.getUsername());
        user1.setPassword(user.getPassword());
        return user1;
    }

总结:

1.我们可以通过Swagger给一-些比较难理解的属性或者接口， 增加注释信息
2.接口文档实时更新
3.可以在线测试
Swagger是一个优秀的工具, 几乎所有大公司都有使用它
[注意点]在正式发布的时候，关闭Swagger! ! !出于安全考虑。而且节省运行的内存;