我们借助于nginx的反向代理功能,帮助我们实现接口的调试功能
假设还是提供静态JSON的方式,我们只需要在nginx的配置节点中添加一层location即可
如下:
通过以上配置,我们即可预览及调试我们的接口文档
但是
那或许我们可以换一种方式,我们将该服务下的所有接口理解为一个服务,我们给一个服务取一个特点的名称,然后通过聚合服务的方式,将文档聚合显示出来,这样既可进行调试
例如:
将127.0.0.1:8999
理解为service1
我们在访问该服务的接口时加上服务前缀:,此时,不管我们的接口又多么不规范,只要是service1下的接口,nginx都会将它转发到127.0.0.1:8999
这台服务上,这样我们也完成了接口的调试
nginx配置:
针对这种情况,在分组属性中,扩展了一个basePath
属性值
此时,我们的group.json
文件如下:
此时,我们的Swagger的JSON路径地址,我们也可以使用我们服务提供给我们的接口地址,只需要加上为服务名称,分组名称即可得到该服务的Swagger JSON文件
通过这种方式,我们可以在文件中聚合所有后端的Swagger服务接口,最终一致输出显示
效果如下: