URL Shortener

這是一份申請 Dcard 2022 Backend Intern 的作業 詳情可見：需求書（PDF 說明檔） 或 職缺說明

Get started

首先將專案 clone 下來

git clone [email protected]:wama-tw/URL-Shortener.git

進入專案資料夾

cd URL-Shortener

裝好相依套件

npm install

複製 .env.example 並改名為 .env.development

cp .env.example .env.development

開啟 MySQL（可參考：https://hub.docker.com/_/mysql) 並修改 .env.development 然後利用 migration 將 DB 建好

npm migrate:postgres

如果要使用測試資料庫

npm migrate:postgres:test

最後開始接收 request

npm start

APIs

使用已有的縮網址

GET HTTP request to a shorten URL（Example: http://localhost:3000/1） It will redirect to the original URL

新增一個縮網址

POST HTTP request to /api/urls with Request Body

{
  "url": "https://medium.com/@wama.tw",
  "expireAt": "2022-04-08T09:20:41Z"
}

Example Response

{
  "id": 1,
  "shortUrl": "http://localhost:3000/1"
}

更新一個縮網址

PUT HTTP request to /api/urls/:id with Request Body

{
  "url": "https://medium.com/@wama.tw",
  "expireAt": "2022-04-08T09:20:41Z"
}

Example Response

{
  "id": 1,
  "shortUrl": "http://localhost:3000/1"
}

刪除一個縮網址

DELETE HTTP request to /api/urls/:id

Example Response

{
  "id": 1,
  "original_url": "https://medium.com/@wama.tw",
  "expire_at": "2022-04-08T09:20:41.000Z"
}

思路

一開始便是抱著挑戰及學習的心態開始寫此份作業的，因此實作的順序是先使用 node.js 實作出基礎要求的功能，再慢慢建構架構及撰寫測試，最後使用 GitHub Action 實現 CI。 Test 的部分先使用 feature test 的方式測試，主要是因為這個專案比較小，一個 feature 也只有用到一個 function，所以沒有再另外寫 Unit test。

DB & 3rd Party Lib

• MySQL
  • 以前曾經使用過 Laravel 搭配 MySQL，這次希望專注於學習 node.js，因此選擇熟悉的 DB
• express
  • 使用 node.js 建立 Web server 時常搭配且方便使用的工具，可以建立 MVC 框架
• nodemon
  • 開發時可以在存檔時自動重新啟動 server，很方便
• prisma
  • 協助連線、管理資料庫的工具，紀錄資料庫欄位變動（migration），也不用在 js 中混雜 SQL 語法。
• dotenv
  • 可以將測試、CI、production 的環境變數分開獨立成不同的 env 檔。方便管理，也可以避免 production 的資料被放進 git
• dotenv-cli
  • 可以用指令指定要使用哪一個 env 檔
• @faker-js/faker
  • 可以自動產出假資料幫助測試
• supertest
  • 在測試時模擬 http request 給指定的 endpoint
• jest
  • JavaScript 的測試框架