[ADP-305] 相對 URI 路徑中的 /api/

指導原則

• 不應(SHOULD NOT)在相對 URL 路徑中包含 /api/（不包括域名）。

為了維持乾淨直觀的 URL 結構，建議 API 的 URL 路徑不應包含 /api/ 段。這種做法遵循簡單性原則，確保 URL 對用戶友好且易於理解。

使用 api 子域名是可以接受的。(如https://api.my.dev)

例外情況:如果您的網絡服務器無法在不同域名上提供網頁和 API，您可以在路徑中包含 /api/ 以作區分。

示例

推薦

• https://api.example.com/users
• https://api.example.com/orders
• https://api.example.com/products

不推薦

• https://example.com/api/users
• https://example.com/api/orders
• https://example.com/api/products

參考資料

• Zalando API Guidelines