为什么
在微服务只能访问自己工程中的 api,如果要访问其他微服务提供的 api 那就需要更换 url
比如,访问微服务提供者9001的 api 接口文档:
http://localhost:9001/swagger-ui.html
又想要访问微服务提供者9002的 api 接口文档,那就需要更换访问地址:
http://localhost:9002/swagger-ui.html
如果能在网关中直接查看 swaggerAPI 的话,那么所有微服务的 api 就都可以查看了
怎么做
1、改 pom
<!-- swagger ui 组件: 前两个是原生的\第三个是优化过的,界面更加清晰 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.3</version>
</dependency>
2、改配置
配置 swagger:
/**
* @Author: xj0927
* @Description: Swagger 文档配置类
* @Modified By: xj927
*/
@Configuration //注入Spring容器
@EnableSwagger2 //发现swagger
public class SwaggerConfig {
@Bean
@Order(value = 1)
public Docket groupRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(groupApiInfo());
}
//Api文档信息
private ApiInfo groupApiInfo() {
//联系人方式
Contact contact = new Contact("xj927", "www.baidu.com", "xxx@163.com");
return new ApiInfoBuilder()
.title("swagger文档信息 zuul")
.description("swagger_ui_Restful 在 zuul 网关配置的微服务接口信息")
.contact(contact)
.version("1.0")
.build();
}
}
配置路径映射 :
/**
* @Author: xj0927
* @Description: 配置路径映射
* @Date Created in 2020-12-25 12:05
* @Modified By:
*/
@Configuration//注入容器
@Primary //如果有多个配置文件,以这个为准
//实现SwaggerResourcesProvider,配置swagger接口文档的数据源
public class SwaggerResourceConfig implements SwaggerResourcesProvider {
//RouteLocator可以根据zuul配置的路由列表获取服务
@Autowired
RouteLocator routeLocator;
//这个方法用来添加swagger的数据源
@Override
public List<SwaggerResource> get() {
//获取所有router
List<SwaggerResource> resources = new ArrayList<>();
List<Route> routes = routeLocator.getRoutes();
//遍历路由方式自动添加所有微服务 API 文档 这样不需要手动添加,实现动态获取
for (Route route : routes) {
resources.add(swaggerResource(route.getId(), route.getFullPath().replace("**", "v2/api-docs")));
}
return resources;
}
private SwaggerResource swaggerResource(String name, String location) {
SwaggerResource swaggerResource = new SwaggerResource();
swaggerResource.setName(name);
swaggerResource.setLocation(location);
swaggerResource.setSwaggerVersion("2.0");
return swaggerResource;
}
}
两个配置类也可以写在同一个类中
3、测试
访问 swagger-ui :
http://localhost:9999/api/manager/swagger-ui.html
访问 doc.html :
http://localhost:9999/api/manager/doc.html