utaipei-sa / reserve.utsa Goto Github PK

Is your feature request related to a problem? Please describe.
有點懶得維護文件😆

Describe the solution you'd like
使用 OpenAPI 及 Swagger 自動生成 API 文件（希望達到像是 FastAPI 一樣的效果）

Describe alternatives you've considered
不能自動生成的話也還可以接受

Additional context
參考資源：https://www.npmjs.com/package/swagger-ui-express

• 從 CommonJS 改用 ES6 語法
• 使用 ESLint 統一程式撰寫風格

於新增預約紀錄至資料庫後, 寄送 Email 至預約者的電子信箱

檔案:

• /server/routes/reserve/POST_reservation.js

功能:

• 新增預約紀錄至資料庫並取得資料 ID
• 將資料 ID 放入信件內容(連結)當中
• 寄出 Email
• 回傳結果

檔案: /server/routes/reserve/GET_reservation.js

資料庫：

• reservations
• items_reserved_time
• spaces_reserved_time

於新版預約紀錄更新至資料庫後, 寄送 Email 至預約者的電子信箱

檔案:

• /server/routes/reserve/PUT_reservation.js

功能:

• 將資料 ID 及更新的資料放入信件內容(連結)當中
• 寄出 Email
• 回傳結果

檔案:

• /server/routes/reserve/POST_reservation.js

功能:

• Receive data from the request body
• Check data format
• Insert data into the database and get a data ID

接收 / 輸入資料說明: 請見 localhost:3000/docs

相關的資料庫集合(collections):

• reservations: 預約紀錄資料
  (1 份文件 = 1 筆預約紀錄)
• space_reserved_time: 場地預約時段資料
  (1 份文件 = 1 個特定場地被預約 1 小時)
• item_reserved_time: 物品預約數量時段資料
  (1 份文件 = 特定數量的 1 種物品被預約 1 天)

註:

• MongoDB 的 1 份文件就是 1 筆資料，很多份同類型的文件組成一個 collection
  (collection 類似於表格, document 類似於表格中的一列)

檔案:

• /server/routes/reserve/GET_integral_item_availability.js

資料庫 collection:

• items_reserved_time

檔案:

• /server/routes/reserve/GET_interval_item_availability.js

資料庫 collection:

• item_reserved_time

Make a basic reservation form (a form page, a confirmation page, and a result page).

預約紀錄刪除後，寄送 Email 通知原預約者

檔案:

• /server/routes/reserve/DELETE_reservation.js

Connect to the email service and send an email.

Connect to the MongoDB Cluster and read/write successfully.

檔案:

• /server/routes/reserve/DELETE_reservation.js

資料庫 collection:

• reservations
• items_reserved_time
• spaces_reserved_time

Plan the API structure between front-end and back-end

功能: 回傳物品 ID、種類、數量列表

檔案:

• /server/routes/reserve/GET_items.js

資料庫 collection:

• items

檔案:

• /server/routes/reserve/PUT_reservation.js

資料庫 collection:

• reservations
• items_reserved_time
• spaces_reserved_time

Make a page shows spaces/items availability in specific time slots.

Example:

Additional task:

• search specific dates or time slots: a date or an interval.

Add a check mechanism to ensure the item reservation's quantity is not over when the item reservation is on the same date and the total is more than the quantity that can be reserved.

Front-end can reject the user's answer when ze fills in the same date and the same item.

檔案:

• /server/routes/reserve/GET_integral_space_availability.js

資料庫 collection:

• space_reserved_time

檔案:

• /server/routes/reserve/GET_interval_space_availability.js

資料庫 collection:

• space_reserved_time

功能: 回傳場地 ID、場地列表

檔案:

• /server/routes/reserve/GET_spaces.js

資料庫 collection:

• spaces