Swagger 建立 api文档
代码地址:https://github.com/klren0312/stm32_wifi
2017.4.4
第二次增补
1.Swagger
(1)介绍
The World's Most Popular API Framework(世界最流行的API模板)。
(2)工具
- Swagger Editor api文档编辑
- Swagger Codegen 代码生成
- Swagger UI 显示界面
(3)网址
http://swagger.io/
![](https://img.haomeiwen.com/i2245742/9639668083d15cd0.png)
2.api文档制作
(1)Swagger Editor编写
-
1
-
2
-
3
(2)Swagger UI界面
1.在express中定义静态文件路由app.use('/static',express.static('public'));
2.将Swagger UI 代码clone到本地 git clone https://github.com/swagger-api/swagger-ui.git
3.在express项目文件夹中,新建一个叫public
文件夹,将clone后的代码中的dist
文件下所有文件复制到public
文件夹。
4.http://localhost:3000/static/index.html
访问即可
![](https://img.haomeiwen.com/i2245742/4206bba9b07bb2aa.png)
3.界面测试
![](https://img.haomeiwen.com/i2245742/f268ccec9c8115bd.png)
![](https://img.haomeiwen.com/i2245742/96dea4827dd7fb66.png)
@治电小白菜20170404
网友评论