特点
- 自动生成API的工具
- 开源
结果展示
为了首先看到它的强大之处,我先在这里贴张图片供大家查看。
使用
- pom依赖
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
- Swagger 配置类
package com.bcm.task.config; 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; /** * Swagger2 配置类 */ @Configuration // 开启Swagger2 @EnableSwagger2 public class SwaggerConfig { /** * Docket实例 * @return */ @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.bcm.task.controller")) .paths(PathSelectors.any()) .build(); } /** * Swagger apiInfo * @return */ private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("标题") .contact(new Contact("介绍", "官网", "邮箱")) .version("1.0") // 版本号 .description("Api 描述") .build(); } }