利用 Express 與 Swagger 結合起來的 API Model，採用 REST API 原則，並可以自動產生出 Swagger 文件與配合 schema 所定義的型別。
全域安裝套件。
npm i -g將套件安裝在專案裡。
npm i資料庫：MSSQL
設定連線資訊 File：dbconfig.json
{
"user": "travel",
"password": ".travel.",
"server": "10.21.20.101",
"database": "TravelTest_6",
"options": {
"encrypt": true,
"enableArithAbort": true
}
}透過 Swagger 來製作線上版 API 規格文件
檔案簡單設定：swagger.js
const doc = {
info: {
title: "Travel API Document",
description: "Description"
},
host: "localhost:3000",
schemes: ['http'],
}詳情可以參考此套件：swagger-autogen
第一次執行請先生成 Swagger 設定檔後再啟動 API Server
node .\swagger.jsnpm run startor
node .\index.jsor use nodemon (修改文件不用重新啟動)
nodemon .\index.js新增 Controller
在 ./src/controllers 資料夾中建立新的 js
Exameple：create new file travel.js in './src/controllers'
var express = require('express');
var router = express.Router();
router.get('/travel/example', async (req, res, next) => { // method GET
// #swagger.tags = ['travel']
res.send('這是 Travel 測試 API！')
});
module.exports = router;Add router for Travel.js
File：./src/controllers/index.js
var Travel = require('./Travel'); // 引入 Travel.js
app.use('/api', Travel) // 新增 router 路徑重新生成 Swagger UI 後打開連結文件測試API
或者直接貼上網址
localhost:3000/api/travel/example
如果想要執行 SQL 語法
引入 Lib 中的 runSQL.js：
const runSQL = require('../lib/runSQL')參數：
runSQL(sqlcode, req, schema) // SQL語法, 所有request, SQL參數型別定義第一個範例先暫時不用到SQL參數，只先傳一個SQL語法到runSQL之中
File: travel.js
var express = require('express');
var router = express.Router();
var runSQL = require('../lib/runSQL')
router.get('/travel/getcity', async (req, res, next) => { // method GET
// #swagger.tags = ['travel']
let sqlcode = "select CID, CName, NamePath from Class where nLevel = 3" // 要執行的 SQL 語法
let response = await runSQL(sqlcode)
res.json(response)
});
module.exports = router;
定義在 SQL 中變數的型別
在 './src/schema' 當中新增檔案 travel.json
Example File: travel.json
[
{ "attr": "cid", "type": "Int" },
{ "attr": "oid", "type": "Int" }
]| attr | type |
|---|---|
| 變數名稱 | SQL型別 |
在 Swagger UI 中，如果 tags 與 schema 名子一致則會自動帶入 schema 的型別
在 runSQL 中傳入 schema 則會比對 sqlcode 中的 input 與 schema 中的 attr，並帶入 SQL 型別
有傳入變數的版本
在 js 中引入 schema
const schema = require('../schema/travel.json') // travel.js 用到的 sql 變數都會在這個 travel.json 當中定義getCCData GET
const schema = require('../schema/travel.json') // 作為 runSQL 中第三個參數
router.get('/travel/getCCData', async (req, res, next) => { // method GET
// #swagger.tags = ['travel']
let { cid } = req.query // 為 swagger ui 宣告有一個 query 叫 cid
let sqlcode = "select PCID 'pcid', P.CName 'cname', CCID 'ccid', C.CName 'pname', P.NamePath 'namepath' from Class P, Inheritance I, Class C where P.CID = I.PCID and I.CCID = C.CID and P.CID = @cid" // 要執行的 SQL 語法
let response = await runSQL(sqlcode, req, schema)
res.json(response)
});
getCOData POST
router.post('/travel/getCOData', async (req, res, next) => { // method POST
// #swagger.tags = ['travel']
let { cid } = req.body // 為 swagger ui 宣告有一個 body 叫 cid
let sqlcode = "select C.NamePath 'namepath', O.OID 'oid', O.Title 'title', O.Class 'district' from Class C, CO, Object O where C.CID = CO.CID and CO.OID = O.OID and C.CID = @cid" // 要執行的 SQL 語法
let response = await runSQL(sqlcode, req, schema)
res.json(response)
});
