Swageer 2 of Record One

1. Guide package

<!--swagger-->
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-boot-starter</artifactId>
     <version>${
    
    swagger.version}</version>
</dependency>

2. Write configuration files

@Configuration
@EnableSwagger2
public class Swagger2Config {
    
    

    @Bean
    public Docket buildDocket() {
    
    
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInfo())
                .select()
                // 扫描哪些包下面的接口，一般是controller在的包
                .apis(RequestHandlerSelectors.basePackage("com.dcampus.sys.web"))
                .paths(PathSelectors.any())
                .build();
    }



    public ApiInfo buildApiInfo() {
    
    
        return new ApiInfoBuilder().title("weblib api document").description("weblib接口").version("1.0").build();
    }


}

3. Use

@RestController
@Api // 启动API
public class UserController {
    
    


    @Autowired
    private UserService userService;


    @ApiOperation("shshs") //简单接口使用
    @GetMapping("/test")
    public String test(){
    
    
        User user = new User();
        user.setAccount("account1");
        user.setName("account");
        user.setPassword(MD5.hash("mlpan@019"));
        userService.saveUser(user);
        int i = 10 / 0;
        return user.toString();
    }


}

4. Permission release

If you use shiro or Spring security for permission control, resources that need to be released

filterChainDefinitionMap.put("/swagger-ui/index.html", "anon");
filterChainDefinitionMap.put("/swagger-resources/**", "anon");
//filterChainDefinitionMap.put("/api/v2/api-docs/**", "anon");
filterChainDefinitionMap.put("/v2/**", "anon");
filterChainDefinitionMap.put("/webjars/**", "anon");

5. Parameter explanation

@Api：用在请求的类上，表示对类的说明
tags="说明该类的作用，可以在UI界面上看到的注解"
value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
    name：参数名
    value：参数的汉字说明、解释
    required：参数是否必须传
    paramType：参数放在哪个地方
        · header --> 请求参数的获取：@RequestHeader
        · query --> 请求参数的获取：@RequestParam
        · path（用于restful接口）--> 请求参数的获取：@PathVariable
        · body（不常用）
        · form（不常用）    
    dataType：参数类型，默认String，其它值dataType="Integer"       
    defaultValue：参数的默认值
    allowMultiple：数组类型的参数，需要设置为true

@ApiResponses：~~ ***用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
    code：数字，例如400
    message：信息，例如"请求参数没填好"
    response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
        （这种一般用在post创建的时候，使用@RequestBody这样的场景，
        请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性