Deploy Swagger UI in Nginx
Table of Contents
1. Deploy Swagger UI in Nginx
假设你已经生成了 API 文档的描述文件 swagger.json,如何把它部署到 Swaager UI 中,以方便查看呢?
首先,准备下面 nginx 配置文件(假设 nginx 网站根目录为 /home/user1/swagger/):
server { listen 8080; server_name 192.168.1.100; root /home/user1/swagger/; index index.html index.htm; }
然后,下载 Swagger UI 相关文件,把 dist 子目录中的所有文件复制到 nginx 相关目录中:
$ git clone https://github.com/swagger-api/swagger-ui.git $ sudo cp -R swagger-ui/dist/* /home/user1/swagger/ # 我们只需要dist目录中的文件
然后,把 swagger.json 放到 /home/user1/swagger/doc 目录中,这样通过“http://192.168.1.100:8080/doc/swagger.json” 就可以访问到这个 API 描述文件。
打开文件 /home/user1/swagger/index.html,把下面内容:
url: "https://petstore.swagger.io/v2/swagger.json"
修改为:
url: "http://192.168.1.100:8080/doc/swagger.json"
最后,使用浏览器访问“http://192.168.1.100:8080/” 即可看到 Swaager UI 页面了。
参考:http://www.whiteboardcoder.com/2013/06/installing-swagger-restful-api.html