swagger 环境搭建

swagger 环境搭建

一、安装nojs

              Window 上安装Node.js

              1、Windows 安装包(.msi)

                      32 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi

                      64 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi

              2、双击下载好的安装包。

              3、点击运行按钮。

              4、勾选接受协议选项,点击 next(下一步) 按钮 。

              5、Node.js默认安装目录为 "C:\Program Files\nodejs\" , 你可以修改目录,并点击 next(下一步)。

              6、点击树形图标来选择你需要的安装模式 , 然后点击下一步 next(下一步)。

              7、点击 Install(安装) 开始安装Node.js。你也可以点击 Back(返回)来修改先前的配置。 然后并点击 next(下一步)。

              8、点击finish退出安装模式。

              9、测试。在windows命令输入:node --version,出现本版号的说明安装成功

              如有不懂可以去:http://www.runoob.com/nodejs/nodejs-install-setup.html查看。

二、swagger-editor环境搭建

             1、下载swagger-editor。地址:https://github.com/swagger-api/swagger-editor/releases/download/v2.10.4/swagger-editor.z

            2、下载后解压后运行如下命令 npm install -g http-server  这是指安装http-server服务器,-g是指全局安装,在安装nodejs时可指定全局位置。

            3、然后运行如下命令,启动该项目http-server swagger-editor,默认为8080端口 ,若想更换端口则使用如下命令 http-server –p 8082 swagger-editor,启动成功如下;

swagger 环境搭建

               5、浏览器访问如下:

swagger 环境搭建

                     6、swagger-editor主要是编写api接口文档,但需要配合swagger-ui来查看,里面的代码格式为yaml

二、swagger-ui官方版(nodejs)环境搭建

                      

1、下载swagger-ui文件,可以通过git下载,路径:https://github.com/swagger-api/swagger-ui
2、下载到本地进行解压。

3、新建node_app文件夹。

4、初始化node初始化命令npm init,出现如下信息,填的地方可以随便写,也可以不写

swagger 环境搭建
5、将下载的swagger-ui中的dist文件夹拷贝到node_app下:

6、安装express。命令npm install express 如下图:

swagger 环境搭建

7、在node_app下创建index.js,并将如下代码写入该js中

  1. var express = require('express');  
  2. var app = express();  
  3. app.use('/root', express.static('dist'));  
  4. app.get('/'function (req, res) {  
  5.   res.send('Hello World!');  
  6. });  
  7.   
  8. app.listen(3000, function () {  
  9.   console.log('Example app listening on port 3000!');  
  10. });
8、然后启动,并运行查看,如上代码为3000端口swagger 环境搭建
swagger 环境搭建
如有不明之处可以去:http://blog.csdn.net/ron03129596/article/details/53559803查看