基于Nginx反向代理

在静态部署预览Swagger JSON章节中我们已经讲过如何通过nginx来部署静态文件预览文档，但此时我们会发现存在一个问题，即无法进行接口的调试。

我们借助于nginx的反向代理功能,帮助我们实现接口的调试功能

假设还是提供静态JSON的方式,我们只需要在nginx的配置节点中添加一层location即可

如下：

  1. server {
  2.         listen       18001;
  3.         server_name  192.168.0.112;
  4.         #charset koi8-r;
  6.         location / {
  7.             root /mnt/application/swagger-static;
  8.         }
  9.         location /api/ {
  10.             // Swagger JSON文件中所有以api开头的接口全部走8999的代理
  11.             proxy_pass http://127.0.0.1:8999/api/;
  12.             client_max_body_size   200m;
  13.         }
  15.     }

通过以上配置,我们即可预览及调试我们的接口文档

但是

我们又会发现问题,很多时候,我们所写的接口可能并不规范,并非所有的接口都是以/api开头的,或者以固定的其他格式开头的接口,那此时如果我们以上面的配置方式来配置,当我们的接口以/admin/test这种形式出现时,我们就无法调试该接口

那或许我们可以换一种方式,我们将该服务下的所有接口理解为一个服务,我们给一个服务取一个特点的名称,然后通过聚合服务的方式,将文档聚合显示出来,这样既可进行调试

例如：

将127.0.0.1:8999理解为service1

我们在访问该服务的接口时加上服务前缀：/service1/api/xxx,此时,不管我们的接口又多么不规范,只要是service1下的接口,nginx都会将它转发到127.0.0.1:8999这台服务上,这样我们也完成了接口的调试

nginx配置：

  1. server {
  2.         listen       18001;
  3.         server_name  192.168.0.112;
  4.         #charset koi8-r;
  6.         location / {
  7.             root /mnt/application/swagger-static;
  8.         }
  9.         location /service1 {
  10.             proxy_pass http://127.0.0.1:8999/;
  12.         }
  13.         location /service2 {
  14.             proxy_pass http://127.0.0.1:8998/;
  16.         }
  18.     }

很显然,通过以上配置,最终能达到我们的预期,但是在我们的文档界面中,没有service1这样的basePath属性供我们配置,此时,我们应该如何处理

针对这种情况，swagger-bootstrap-ui在分组属性中,扩展了一个basePath属性值

此时，我们的group.json文件如下：

  1. [
  2.   {
  3.     "name": "微服务-用户模块",
  4.     "url": "/service1/v2/api-docs?group=分组接口",
  5.     "swaggerVersion": "2.0",
  6.     "location": "/service1/v2/api-docs?group=分组接口",
  7.     "basePath":"/service1"
  8.   },
  9.   {
  10.     "name": "微服务-订单模块",
  11.     "url": "/service2/v2/api-docs?group=默认接口",
  12.     "swaggerVersion": "2.0",
  13.     "location": "/service2/v2/api-docs?group=默认接口",
  14.     "basePath":"/service2"
  15.   }
  16. ]

此时,我们的Swagger的JSON路径地址,我们也可以使用我们服务提供给我们的接口地址，只需要加上为服务名称,分组名称即可得到该服务的Swagger JSON文件

通过这种方式,我们可以在group.json文件中聚合所有后端的Swagger服务接口,最终一致输出显示

效果如下：

基于Nginx反向代理 - 图1