SpringBoot使用Swagger2生成接口文档-Toy模板网

这篇具有很好参考价值的文章主要介绍了SpringBoot使用Swagger2生成接口文档。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

一、导入依赖

      <!--        knife4j-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.7</version>
        </dependency>

二、配置类

通过一下配置，将Swagger2自动配置进SpringBoot中

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .protocols(Collections.singleton("http"))
                .host("前台网址")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("标题")
                .description("aurora")
                .contact(new Contact("作者", "", "邮箱"))
                .termsOfServiceUrl("名称")
                .version("1.0")
                .build();
    }

}

三、Controller使用

通过@Api注解和@ApiOperation注解说明模块作用及接口说明。

@Api(tags = "投诉原因模块")
@RestController
public class ComplaintsCauseController {

	@Autowired
	private ComplaintsCauseService complaintsCauseService;

	@ApiOperation("获取投诉所有原因")
	@GetMapping("/users/complaintsCause")
	public ResultVO<List<ComplaintsCause>> getAllComplaintsCause(){
		return complaintsCauseService.getAllComplaintsCause();
	}
}