说明
用Swagger写API文档很美观，还可以很方便的进行API测试。
步骤
1. 下载Swagger
到https://github.com/swagger-api/swagger-ui下载。
2. 编写文档
- 使用Swagger Editor编写 API 文档
Swagger Editor 使用的是YAML，如果不了解，可以看阮老师的教程。
当然，你也可以本地部署Swagger Editor
- 导出JSON
从File菜单选择“Convert and save as JSON”，导出JSON文件。比如，我导出为yang.json
3. 修改Swagger文件
- 进入Swagger的dist目录，修改index.html文件
在index.html找到url: "http://petstore.swagger.io/v2/swagger.json"，把url修改为你的JSON文件路径即可。
比如，我把上一步导出的yang.json放到和index.html同目录，修改url值为"./yang.json" - 把dist目录的内容部署为站点
用你熟悉的工具部署站点。
我是用一条命令创建站点，在dist目录执行命令python3 -m http.server即可创建站点。打开http://localhost:8000访问。
API
你也可以只把JSON文件放到站点上，index.html的url路径用全路径，这样Swagger就不用部署站点，只需要双击index.html用浏览器打开就行了。
网友评论