为什么是“springfox”?
问:我们要使用的是 Swagger,为什么要搜索“springfox”?
答:Swagger 可以看作是一个遵循了 OpenAPI 规范的一项技术,而 springfox 则是这项技术的具体实现。就好比 Spring 中的 AOP 和 DI 一样,前者是思想,而后者是实现。
2.开启Swagger
在 Spring Boot 的启动类或配置类中添加 @EnableSwagger2
注释,开启 Swagger,部分核心代码如下:
@EnableSwagger2 @SpringBootApplication public class Application {...
3.配置摘要信息
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) // 1.SWAGGER_2 .select() .apis(RequestHandlerSelectors.basePackage("com.example.swaggerv2.controller")) // 2.设置扫描路径 .build(); } }
4.访问Swagger
项目正常启动之后使用“http://localhost:8080/swagger-ui.html”访问Swagger页面,如下图所示: