Swagger2是什麼?@EnableSwagger2註解?
阿新 • • 發佈:2018-12-21
轉自:http://ju.outofmemory.cn/entry/355158
首先,引入maven依賴
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency>
Swagger2是一個效率工具
import io.swagger.annotations.Api; import org.springframework.beans.factory.annotation.Value; 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.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * Created by Trace on 2018-05-16.<br/> * Desc: swagger2配置類 */ @SuppressWarnings({"unused"}) @Configuration @EnableSwagger2 public class Swagger2Config { @Value("${swagger2.enable}") private boolean enable; @Bean("使用者模組") public Docket userApis() { return new Docket(DocumentationType.SWAGGER_2) .groupName("使用者模組") .select() .apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) .paths(PathSelectors.regex("/user.*")) .build() .apiInfo(apiInfo()) .enable(enable); } @Bean("客戶模組") public Docket customApis() { return new Docket(DocumentationType.SWAGGER_2) .groupName("客戶模組") .select() .apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) .paths(PathSelectors.regex("/custom.*")) .build() .apiInfo(apiInfo()) .enable(enable); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("XXXXX系統平臺介面文件") .description("提供子模組1/子模組2/子模組3的文件, 更多請關注公眾號: 隨行享閱") .termsOfServiceUrl("https://xingtian.github.io/trace.github.io/") .version("1.0") .build(); } }
import org.springframework.beans.factory.annotation.Value; 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.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * Swagger2 配置 * Created by pmdream on 2018/4/20. */ @Configuration @EnableSwagger2 public class Swagger2 { @Value("${swagger.show}") private boolean swaggerShow; @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .enable(swaggerShow) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("cn.pmdream.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("介面文件") .description("測試Swagger") .termsOfServiceUrl("http://dkreal.cn/") .contact("pmdream") .version("1.0") .build(); } }
= =(留著之後填坑)