Swagger简介 4
安装4
一、Node.js安装4
二、node中http-server安装4
三、下载swagger-editor 4
四、启动swagger-editor 5
五、使用浏览器访问http://localhost 5
使用5
一、编写API文档:7
二、生成服务端代码:8
三、修改&运行服务端:9
四、创建&运行客户端:11
1. 使用swagger-editor的web界面:11
2. 使用swagger-editor生成的客户端代码14
3. 使用chrome的postman插件15
Swagger简介
Swagger包括Swagger Editor,Swagger UI等很多部分,这里我们主要讲一下Swagger Editor。它是一个完全开源的项目,并且它也是一个基于Angular的成功案例。
在Swagger Editor中,我们可以基于YAML等语法定义我们的RESTful API,然后它会自动生成一篇排版优美的API文档,并且提供实时预览。简单说就是可以边编写API 边预览边测试。
在Swagger UI中,我们不能进行编写API ,但是我们可以预览或者测试。
安装
一、Node.js安装
swagger是用node写的,所以需要先按照node。安装nodejs后node和npm会一并安装。
windows中直接运行node-v8.1.2-x64.msi 即可完成安装(我已经下载好,位于:\\10.9.60.201\shares\)
二、node中http-server安装
任一cmd窗口,执行npm install -g http-server
三、下载swagger-editor
安装swagger-editor有多种方式,
l从github下载安装。 这个方式可能行不通,因为下载通常很慢。
l从官网下载swagger-editor.zip,解压即可。(已共享)
四、启动swagger-editor
在swagger-editor的根目录打开cmd窗口,执行http-server,默认为8080端口,若想更换端口则使用如下命令http-server –p 80 或者修改:C:\Users\Administrator\AppData\Roaming\npm\node_modules\http-server\bin\http-server中84行portfinder.basePort = 8080; 改为自己想要的端口。
五、使用浏览器访问http://localhost
结果:
说明:
界面左边是api文件的yaml描述文件,左边部分可以直接编辑API文档,编辑会立即更新到右边视图。右边是swagger-UI,可以查看文档,并直接进行API的测试。