服务应用提供的接口很重要,文档也很重要,调用者需要通过文档才能正确使用服务接口。Swagger是一个很好的接口文档工具,但是使用时也难免遇到一些问题。
配置Swagger
和引入其他第三方工具一样,引入依赖、添加配置。
- 在项目的 pom.xml 里引入依赖
<!-- swagger 主依赖 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- swagger UI 依赖 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
- 开启并配置依赖
@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//swagger要扫描的包
.apis(RequestHandlerSelectors.