Java高级教程之SpringCloud-17:SpringCloud Swagger配置API文档中心
Swagger可以很方便地通过Web管理API文档,比如在产品服务里加入Swagger依赖,就可以通过访问端口查看API文档。
在application.yml配置文件中加入swagger扫描。
重启产品微服务,可以访问swagger-ui.html文档。
http://localhost:8080/swagger-ui.html
访问结果:
接着在产品服务工程加入一个配置类。
package com.lpplpp.product.app.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; 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; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket getDocket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.lpplpp")) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("产品服务API") .version("1.0") .termsOfServiceUrl("localhost:8080/product/") .description("product api") .build(); } }
重启产品微服务,可以看到swagger的界面。