1. 添加依赖
<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> |
2. 创建swagger2配置类
package com.svw.tbox.tcloud.user.provider;
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 publicclass Swagger2 { /** * 通过createRestApi函数创建Docket的Bean之后, * apiInfo()用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。 * select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现, * 本例采用指定扫描的包路径来定义, * Swagger会扫描该包下所有Controller定义的API, * 并产生文档内容(除了被@ApiIgnore指定的请求)。 * * @return */ @Bean public Docket createRestApi() { returnnew Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.svw.tbox.tcloud.user.provider.controller")) .paths(PathSelectors.any()) .build(); }
/** * 用来创建该Api的基本信息(这些基本信息会展现在文档页面中) * * @return */ private ApiInfo apiInfo() { returnnew ApiInfoBuilder() .title("micro SERVICE RESTful-APIs") .description("Restful-API文档,POST添加,GET获取,PUT修改,DELETE删除") // .termsOfServiceUrl("http://localhost:8000/swagger-ui.html") //请求swagger-ui.html .contact(new Contact( |