基於node創建api接口

1.安裝node（已經安裝好了可以跳過）

點擊此次去下載

2.創建項目

　　基於node的express 或 koa

　　在桌面空白處或者其他文件夾空白處 shift+鼠標右鍵   打開powershell窗口

　　全局安裝express 這里以express為例  npm install express-generator -g（鏡像源可以自行切換）

//創建項目  ---選擇需要的模板語音 ejs/jade/pug...
express --view=pug myapp  
//上面表示  創建了一個項目 並引用了pug模板   項目文件名為myapp

//安裝依賴 --  安裝前先cd myapp 到你當前目錄
npm i

//運行項目
npm run start

//當修改源文件的時候，每次都需要重啟服務器  這時我們就可以用到這兩個模塊 nodemon/supervisor

npm i supervisor -g // 只需一次

// 修改package,json 添加運行命令 dev

"scripts": {
     "start": "node ./bin/www", 
     "dev": "supervisor ./bin/www" 
},

//這時我們就可以用 npm run dev啟動服務器了 當修改了原文件會自動幫我們重啟

3.創建相對於的接口文件

　　在項目的根目錄下創建api文件夾，用於存放api接口

　　

 

　　想讓這些api文件全部生效的話需要在app.js中引入接口以及注冊接口 - 記得重新啟動服務器

 

　　

4.編寫接口文檔

　　安裝需要的依賴 npm i apidoc -g

　　修改package.json文件，添加如下代碼

　　

　　然后去api/user.js中配置接口文檔

　　

　　代碼奉上  可以根據實際情況去改

/**
 * @api {post} api/user 注冊功能
 * @apiDescription 注冊功能
 * @apiGroup user
 * @apiParam { string } username 賬號
 * @apiParam { string } tel 手機號
 * @apiParam { string } password 密碼
 * @apiSuccessExample { json } Success-Response:
 * {
 *  code: '10400',
 *  message: '請完善表單信息'
 * }
 * {
 *  code: '10666',
 *  message: '注冊成功'
 * }
* {
 *  code: '10606',
 *  message: '該用戶已注冊'
 * }
 * @apiSampleRequest /api/user
 * @apiVersion 1.0.0
 */

　　最后在開一個終端運行一下命令 ，必須在當前根目錄下     apidoc -i api/ -o public/apidoc/ （前提是你的服務器需要打開  npm run dev）

　　然后在瀏覽器打開http://localhost:3000/apidoc/ （express默認服務器3000端口  需要的話可以去bin文件夾下面的www改）

　　怕忘了 拿小本本記一下