Spring Boot 整合 Swagger2

# pom.xml

<!--引入Swagger依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>

# 新建 SwaggerConfig.class

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInf())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.text.controller"))  // controller层路径
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo buildApiInf() {
        return new ApiInfoBuilder()
                .title("chenbz - API文档")
                .contact(new Contact("Chenbz", "http://url/swagger-ui.html", ""))
                .version("1.0")
                .build();
    }
}

# Controller 使用代码示例

@Api(value = "管理员表接口")
@RestController
@RequestMapping("/api/admin")
@CrossOrigin(value = "*")
public class AdminController extends BaseApiController {

    @Autowired
    private AdminService adminService;

    @ApiOperation(value = "删除管理员", notes = "删除管理员")  // POST请求
    @PostMapping("/delete")
    public Map<String, Object> deleteById(Long id) {
        adminService.delete(id);
        return resp(200, "删除成功");
    }

    @ApiOperation(value = "查询所有管理员信息", notes = "查询所有管理员信息")  // GET请求
    @GetMapping("/list")
    public Map<String, Object> list() {
        return resp(200, "查询所有成功", adminService.list());
    }
}

转载自：https://mrbird.cc/Spring-Boot-Swagger2-RESTful-API.html