Swagger

配置分组、设置隐藏等

增加分组与配置

@Configuration
@EnableSwaggerBootstrapUI
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("newDocket")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.kunchi.oms.spi.fix"))
                .paths(PathSelectors.any())
                .build();
    }
}

效果：

隐藏API

方法一 去掉Controller上的@Api注解
方法二 在方法上加@ApiOperation(hidden=true)

@ApiOperation(value = "This API will be hidden in Swagger UI", hidden = true)
@GetMapping("/hiddenApi")
public ResponseEntity<String> hiddenApi() {
    return ResponseEntity.ok("This is a hidden API");
}

API分组展示

（即使不在同一个Controller下，tags相同也会被展示在同一组）

@Api(tags = "User Operations")
@RestController
@RequestMapping("/users")
public class UserController {
    @ApiOperation(value = "Get user by id", tags = "User Management")
    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        // ...
    }
}

@Api(tags = "Admin Operations")
@RestController
@RequestMapping("/admins")
public class AdminController {
    @ApiOperation(value = "Get admin by id", tags = "User Management")
    @GetMapping("/{id}")
    public Admin getAdmin(@PathVariable Long id) {
        // ...
    }
}

---