ZY.Node.Mongodb
-
https://gitee.com/Z568_568/node.mongodb.git
-
https://github.com/ZHYI-source/ZY.Node.Mongodb.git
專案介紹
-
基于 Node.js、Express.js 和 MongoDB 通過Mongoose驅動進行 REST API 開發的輕量級樣板，
集成了Swagger UI、JWT、session、發送郵箱驗證、日志管理、統一的預定義狀態碼回應格式等，對于為前端平臺構建純凈的Web API非常有用， -
該專案我嘗試做出輕松維護代碼結構的專案樣板，因為任何初學者也可以采用該流程并開始構建API，
-
專案開放，可以提出建議、錯誤的issues，
專案特點
- 輕量級Node.js專案提供Restful API
- 資料庫采用 Mongodb, 通過Mongoose驅動，
- CRUD操作示例
- 跨域處理
- 日志管理
- 具有恰當的狀態代碼的預定義回應結構
- 全域錯誤處理
- 增加express-validator請求引數校驗
- jwt驗證 用戶權限中間件分離
- 基本身份驗證（采用bcrypt單向Hash加密演算法加密密碼進行注冊/登錄）
- Token生成和校驗請求頭的authorization
- 集成swagger-ui
- 增加郵件驗證碼通知
- session 驗證碼校驗
- 采用jest 介面單元測驗
如何獲得并運行專案：
首先確保您系統中安裝了Mongodb，和Nodejs，一起準備完善之后，按照如下操作，
有的同學啟動會報錯可能是依賴包的版本問題需要注意
我的環境配置供參考
- Node.js 14.18.1+
- MongoDB 5.1+
1，clone代碼
git clone https://gitee.com/Z568_568/node.mongodb.git
2，安裝依賴
npm install
3，啟動程式
開發環境：npm run dev 基于 nodemon 熱更新
生產環境：npm run start
4，啟動成功示例
如何增加新的model
只需在 /models/v1/mapping/ 中創建一個新檔案，
然后在控制器/controllers/v1/中創建一個對應新模型的新控制器的并使用，
如何增加新的路由router
只需在 /routes/v1/ 中創建一個新檔案，并且引入它對應的controllers進行使用，routes下面的檔案 將被 mount-routes插件自動決議并以檔案名作為api根路徑，
開發環境下會列印在終端上：
如何增加新的控制器
只需在 /controllers/v1/ 中創建一個新檔案即可，并且引入相關模型進行使用
如何理解內置的登錄注冊邏輯
/*
* TODO: 注冊登錄大概邏輯：
* 1.用戶注冊 - 用戶資訊入庫 - 發送驗證碼 - 校驗驗證碼
* |
* 驗證碼發送失敗、驗證碼失效或者校驗失敗 - 重新發送或輸入驗證碼 - 校驗驗證碼
* *
* 2.用戶登錄 -（賬號、密碼、驗證狀態都校驗通過）- 發Token
* |
* 驗證狀態不通過 - 重新校驗驗證碼/重發驗證碼 - 校驗驗證碼 - 發Token
* */
專案結構
.
├── app.js //入口檔案
├── package.json //依賴組態檔
├── .env.development //開發環境配置
├── .env.production //生產環境配置
├── config //專案配置
│ ├── db.config.js
│ ├── swagger.config.js
│ └── ...
├── controllers //控制模塊（業務處理）
│ └── v1
│ ├── UserController.js
│ └── ...
├── models //模型模塊（建表）
│ └── v1
│ ├── user.test.js /模型統一匯出
│ └── mapping
│ ├──UserModel.js
│ └── ...
├── routes //路由（配置實際API地址路徑）
│ └── v1
│ ├── user.test.js
│ ├── user.js
│ └── ...
├── db //mongodb資料庫連接
│ ├── user.test.js
│ └── ...
├── middlewares //中間件
│ ├── jwt.js
│ ├── permissions.js
│ ├── session.js
│ └── ...
├── logs //日志
│ ├── info.log
│ ├── error.log
│ └── ...
└── utils //輔助工具
├── utils.apiResponse.js
├── utils.mailer.js.js
└── ...
關于作者
創建和維護由
- @ZY_GITEE
- @ZY_GITHUB
- 想咨詢其他或合作請發我郵箱[email protected]
- 到我主頁留言http://www.zhouyi.run
- 我的博客站點http://blog.zhouyi.run
本文來自博客園，作者：書中楓葉，轉載請注明原文鏈接：https://www.cnblogs.com/zy-mg/p/17293391.html
轉載請註明出處，本文鏈接：https://www.uj5u.com/qiye/549350.html
標籤：其他