Node js X Swagger

--------- 藍色字 代表要下的指令

1.安裝 Node js

參考資料：https://nodejs.org/en/

先至 https://nodejs.org/en/ 下載.exe 檔。

2.安裝完畢後，打開 cmd

指令 node -v

指令 npm -v

如果有出現版號，代表安裝成功！

建立一個安裝node js專案的資料夾，指定到專案的資料夾，如下：

 

3.安裝 Swagger  

//參考資料 https://github.com/swagger-api/swagger-node

作業系統執行 npm 命令時，出現上面以上畫面，代表，您的系統沒有安裝 npm，

但…通常你裝了 node js.exe 檔，下達  npm -v 出現版號後，就可以開始使用。

npm install -g swagger

===   如果之前就跑過 Swagger 可以從以下開始    ===

4.建立Swagger的資料夾

swagger project create opendata <=== 資料夾名稱，選擇 express

express使用方式可參考：http://expressjs.com/zh-tw/

成功的話，就會出現 opendata

cd opendata <=== 資料夾名稱

如果想開啟編輯畫面可以下此指令：

swagger project edit

啟動Sever

swagger project start

啟動功能「預設」會出現 curl http://127.0.0.1:10010/hello?name=Scott

加入網址會出現「Hello, Scott！」

=======================================================

安裝下面三個檔案才能顯示Swagger UI並可以讀 yaml 檔

npm install swagger-ui

npm install swagger-tools

npm install yamljs

/// 安裝 swagger-ui-express

npm install swagger-ui-express

更新 /api/swagger/swagger.yaml。

網址：http://localhost:10010/api-docs/

====== app.js 修改成 Swagger 資料

'use strict';

var express = require('express');

var app = express();

var swaggerUi = require('swagger-ui-express');

var YAML = require('yamljs');

var swaggerDoc = YAML.load('api/swagger/swagger.yaml');/////指定到「此資料夾的」 

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDoc));

app.get('/', function (req, res) {

  res.send('Server is exist!')

});

var PORT = 10010;

app.listen(PORT);//監聽 port