Swagger UI及 Swagger editor教程 API文档搭配 Node使用

2,648 阅读1分钟

#简介

swagger ui 是一个在线文档生成和测试的利器,目前发现最好用的。为啥好用呢?

  • 支持API自动生成同步的在线文档
  • 方便测试人员了解 API
  • 这些文档可作为客户产品文档的一部分进行发布
  • 支持API规范生成代码,生成的客户端和服务器端骨架代码可以加速开发和测试速度

下载

git clone https://github.com/swagger-api/swagger-ui.git

Swagger Editor 编写 API文档

官网:editor.swagger.io/#/

  • Swagger Editor 上的是基于 yaml的语法
  • 导出 swagger.json 文档
  • 利用编辑器修改node_app/public/index.html中的URL路径 url
"http://petstore.swagger.io/v2/swagger.json"为url
:http://localhost:3000/static/swagger.json