跳到主要內容

建立 Mock REST API

自訂方法、路徑、狀態碼、延遲時間,以及回應內容或自動產生的假資料,就能建立假的 JSON 端點。端點由我們的伺服器提供並支援 CORS,適合用於原型開發與測試。

參數請用 :name,例如 /users/:id

回應內容
延遲0 ms

像 "{{fullName}}" 或 "{{int(1, 100)}}" 這樣的字串會在每次請求時被取代。

筆

0 代表回傳單一物件

預留位置(36)
{{id}}
1、2、3…,在清單中的位置
{{index}}
0、1、2…,從 0 開始的位置
{{uuid}}
隨機 UUID v4
{{firstName}}
名字
{{lastName}}
姓氏
{{fullName}}
姓名
{{username}}
小寫帳號名稱
{{email}}
example.com 的電子郵件地址
{{phone}}
電話號碼(+1 555…)
{{company}}
公司名稱
{{jobTitle}}
職稱
{{street}}
街道地址
{{city}}
城市
{{country}}
國家
{{countryCode}}
ISO 3166 代碼
{{zip}}
5 位數郵遞區號
{{domain}}
範例網域
{{url}}
https 網址
{{ipv4}}
文件保留範圍的 IPv4
{{color}}
HEX 色碼
{{word}}
一個 lorem 單字
{{words}}
words(n):n 個 lorem 單字
{{sentence}}
lorem 句子
{{paragraph}}
三到五個句子
{{int}}
int(min, max):整數
{{float}}
float(min, max, decimals)
{{price}}
price(min, max):兩位小數
{{bool}}
true 或 false
{{date}}
過去一年內的日期(YYYY-MM-DD)
{{datetime}}
過去一年內的 ISO 日期時間
{{futureDate}}
未來一年內的日期
{{status}}
active、pending 或 inactive
{{pick}}
pick(a, b, c):從選項中擇一
{{param}}
param(name):URL 路徑中的值,例如 :id
{{query}}
query(name):查詢字串中的值
{{null}}
JSON null
回應標頭(選填,僅限 X-)
3 / 10 個端點・啟用 CORS 的 JSON 回應
在我們的伺服器上處理 · 端點的 JSON 會保留到你刪除為止,或連續 7 天沒有任何請求時自動刪除運作方式

Mock REST API 使用方法

  1. 1

    設定每個端點

    選擇方法,輸入路徑(例如 /users/:id),再設定狀態碼,以及用來模擬網路緩慢的延遲(可不設定)。

  2. 2

    撰寫回應內容

    貼上固定 JSON,或切換到「假資料」,用 {{fullName}} 這類佔位符撰寫 JSON 範本,並設定清單筆數。

  3. 3

    建立模擬 API

    按下「建立模擬 API」就會取得基礎網址;每個端點都能透過該網址加上路徑呼叫,並已啟用 CORS。

  4. 4

    呼叫並反覆調整

    用「試用」、curl 或應用程式中的 fetch 呼叫,之後可編輯並儲存(變更會立即生效),用完再刪除這個模擬 API。

限制與 Pro

免費:每個模擬 API 最多 10 個端點,每個內容上限 100 KB、總計 512 KB,延遲最長 5 秒,產生的清單最多 100 筆,每位訪客每分鐘 120 次請求,每小時可新增 10 個模擬 API,7 天沒有請求就會刪除。

Pro 方案將上限提高到 50 個端點、1 MB 的內容、30 秒的延遲,以及 1,000 筆的清單。 查看 Pro

關於 Mock REST API

模擬 REST API 讓前端與行動裝置開發者在真正的後端完成前,就能使用可運作的端點。每個模擬 API 在 /api/mock-api/m/ 底下都有專屬的基礎網址,你定義的每個端點都會依你設定的方法、路徑、狀態碼、延遲、標頭與 JSON 內容回應。路徑可以包含參數,因此 /users/:id 能對應 /users/7,範本也可以用 {{param(id)}} 回傳該值,或用 {{query(name)}} 讀取查詢字串。

假資料模式會用 36 種佔位符,把 JSON 範本變成擬真的回應,涵蓋姓名、電子郵件、公司、城市、UUID、日期、價格、指定範圍內的數字和 lorem 文字。設定清單筆數後,最多可回傳 100 筆的陣列,也能決定每次請求的資料是否維持不變(適合快照測試)或每次都不同。200 到 599 的狀態碼,能讓你預先演練 401、404、429、503 等錯誤情境;最長 5 秒的延遲則能檢視載入狀態的表現。

回應一律為 JSON 並附上 CORS 標頭,任何來源的瀏覽器都能呼叫。模擬 API 無法提供 HTML、設定 Cookie 或重新導向,也不會儲存收到的請求,更不是資料庫:POST 與 PUT 只會回傳你設定的內容,不會儲存傳入的任何資料。

隱私

為了代管你的端點,你儲存的定義(方法、路徑、狀態碼、延遲、標頭與內容)會傳送並儲存在我們的伺服器,同時儲存經過雜湊的編輯權杖、建立與最後請求的時間,以及請求次數。對端點的請求會直接回應,不會記錄請求的內容、標頭或 IP 位址。模擬 API 會在你刪除時移除,或在 7 天內沒有請求也沒有編輯時自動刪除,編輯權杖只保存在這個瀏覽器中。任何人只要有網址就能呼叫你的端點,請勿放入機密或真實的個人資料。

功能

真正的 HTTPS 端點

支援任何方法、路徑參數、200 到 599 的狀態碼、延遲,以及自訂 X- 標頭。

假資料範本

提供超過 30 種佔位符,涵蓋人物、公司、地點、日期、數字和文字,可產生單一物件或清單。

安全的設計

僅限 JSON、已啟用 CORS、不記錄請求、編輯權杖經雜湊,閒置 7 天後自動刪除。

Mock REST API:常見問題

伺服器上會儲存什麼,會保留多久?
我們會儲存你保存的端點定義、編輯權杖的 SHA-256 雜湊、模擬 API 的建立與最後呼叫時間,以及收到的請求次數,不會記錄請求內容、標頭或 IP 位址。模擬 API 會在你按下「刪除」時移除,或在 7 天內沒有任何請求或編輯時自動刪除,所以持續使用的 API 會一直可用。
我可以從前端應用程式呼叫這個模擬 API 嗎?
可以。每個回應都帶有設為 * 的 Access-Control-Allow-Origin,預檢的 OPTIONS 請求也會回應,因此任何網域(包括 localhost)上的 fetch、axios 或其他瀏覽器 HTTP 用戶端都能呼叫。使用基礎網址加上端點路徑即可,例如 fetch(base + "/users")。端點是一般的 HTTPS 網址,所以行動應用程式、Postman 和 curl 也都能使用。
假資料佔位符是怎麼運作的?
在「假資料」模式下,JSON 範本中屬於佔位符的字串,例如 "{{email}}" 或 "{{int(1, 100)}}",會在收到請求時被取代;整個字串就是數字或 true 或 false 佔位符時,會變成真正的 JSON 數字與布林值。佔位符也能放在文字中,例如 "Hello {{firstName}}"。設定清單筆數即可重複範本,{{id}} 會為每筆依序編為 1、2、3。
模擬 API 可以回傳錯誤或延遲回應嗎?
可以。你可以選擇 200 到 599 的任何狀態,例如 401 Unauthorized、404 Not Found、驗證錯誤用的 422、429 Too Many Requests 或 503,並寫出應用程式預期的錯誤 JSON。免費方案的延遲最長可讓每個回應等待 5 秒,有助於測試載入動畫、逾時與重試邏輯。狀態 204 和 304 的回應不會附帶內容。
為什麼模擬 API 不能回傳 HTML 或設定 Cookie?
可回傳任意內容的免費代管端點,常被用來製作釣魚頁面和惡意軟體連結。為了讓這些模擬只能當作 API 使用,每個回應都是 application/json,並附上 nosniff 與嚴格的內容安全政策,自訂標頭也只允許以 X- 開頭的項目,因此無法設定 Cookie、重新導向瀏覽器或偽裝成網頁。