Swagger可以实现很多功能，这里只说最基础、常用的：
1. API文档撰写 —— Swagger Editor
2. API文档的显示 —— Swagger UI
3. 生成Mock服务 —— Swagger Editor
目前我们很多项目采用的都是新建一个markdown，写文档，每次改接口，就打开旧的markdown=>编辑=>保存=>复制并发布到项目wiki。
Swagger Editor可以解决1、3、4，不止具有语法提示、语法检测，还支持定义对象，一处定义多处使用，减少重复编写，写好后可以一键生成Mock Server，而且支持生成多种语言的：
Swagger UI则是一套Web展示框架，把你用Swagger Editor写出来的东西，漂亮地展示出来：
首先， 安装Editor ，安装方式多种可选。
最简单的就是使用Docker，只需要pull镜像，run镜像，就可以使用了，完全不用任何多余步骤。
不推荐在线Editor，亲测特别慢，毕竟是国外的服务器。
此处有两个概念，不要混淆： 语法（YAML或者JSON 和 规范（OpenAPI） 。
OpenAPI规范就是我们期望的一套API撰写的完整规范，包括如何说明参数、请求方法、响应码、响应体等。
YAML和JSON是Swagger Editor能够读懂的语法。
用YAML或者JSON写出符合OpenAPI规范的文档 = 用JavaScript写出符合Restful规范的接口
建议打开 Swagger的在线Editor ，对照着示例，边看边敲边学。
我们希望文档能跟在项目中，项目部署到服务器后，可以在项目服务器浏览到文档，而不用单独管理文档。
非常简单，在Editor中选择 Generate Server ，选择你想要的语言就可以：
我们之前使用Swagger Editor编辑文档，也可以借助框架，从注释生成文档，而不使用Editor。
使用 swagger-tools 的 swagger-router中间件 即可实现，具体没有测试，待大家发现。
Swagger是一个REST APIs文档在线自动生成和测试的框架，默认已经有 nodejs环境 。
选择一个合适目录执行以下命令
在 /node-swagger 新建 index.js 文件，内容如下：
node index.js 启动项目，访问浏览器输入 http://localhost:3000/static/index.html 即可查看相关效果。
