API 網址這樣設定有夠棒！
閱讀時間約 2 分鐘
網址是 API 的門面，大家使用 API 的第一步就是要看它。
第一眼就要讓人就知道這隻 API 在做什麼？
甚至因為遵循標準（目前 REST 是主流），可以類推 API 應該會有什麼功能等等。
第一眼就要讓人就知道這隻 API 在做什麼？
甚至因為遵循標準（目前 REST 是主流），可以類推 API 應該會有什麼功能等等。
網址規劃的好，未來隨著需求變化也比較有彈性能夠修改 / 擴充。
網址設定跟著這些原則走，輕鬆沒煩惱
1. 命名簡單明瞭
https://api.test.com/products/1234
這個網址代表是一個 api 的位置，這會取得編號 1234 的商品資料 (products)
這個網址代表是一個 api 的位置，這會取得編號 1234 的商品資料 (products)
2. 不要使用過度簡化的單詞
https://api.test.com/p/666
這邊 p 代表是 products 嗎？還是 plan ?
這邊 p 代表是 products 嗎？還是 plan ?
3. 以小寫英文為主
因為有些系統會識別大小寫英文（代表不同的東西：例如： Products vs. products 視為不同）
另外，國際主流語言還是以英文為主（畢竟電腦也是美國發明的～）
4. 避免使用自定義名詞
- https://api.test.com/free_choice/555
餐餐自由選？ - https://api.test.com/tuango/888
團購商品？
5. 使用複數名詞命名
這個牽涉到 REST 的設計原則：如果沒有帶識別詞（例如：編號）就等同於取得列表
https://api.test.com/products
取得商品列表（一坨商品）
https://api.test.com/products/1234
取得編號 1234 的商品資料（一個商品）
另外，使用名詞也是因為 REST 的原則而設計：動作應該由 HTTP 請求的 [方法] 決定
[GET] https://api.test.com/products
取得商品資料
[POST] https://api.test.com/products
新增商品資料
[PUT] https://api.test.com/products/1234
更新商品資料（全部欄位）
[DELETE] https://api.test.com/products/1234
刪除商品資料
[UPDATE] https://api.test.com/products/1234
更新商品資料（部分欄位）
6. 避免使用特殊符號
特殊符號可能會造成網址編碼上的問題，產生非預期的結果，不過現在瀏覽器很聰明都會幫忙轉碼。
但是，有些特殊符號是有特別意義的，例如：點 ( . ) 拿來區分網域、連接符號 (&) 用來連接 [GET] 複數參數用
11會員
23內容數
這一系列是我的讀書心得，也算是一個擷取書中精華的書摘。
希望可以讓你對這些書有興趣，到書店看到它可以拿起來看一看~
甚至也可以讓你因此推薦更多相似或者也是很棒的作品給我：)
留言0
查看全部
你可能也想看
Google News 追蹤
這個秋，Chill 嗨嗨！穿搭美美去賞楓，裝備款款去露營⋯⋯你的秋天怎麼過？秋日 To Do List 等你分享！
秋季全站徵文，我們準備了五個創作主題，參賽還有機會獲得「火烤兩用鍋」，一起來看看如何參加吧～
美國總統大選只剩下三天， 我們觀察一整週民調與金融市場的變化（包含賭局）， 到本週五下午3:00前為止， 誰是美國總統幾乎大概可以猜到60-70%的機率， 本篇文章就是以大選結局為主軸來討論近期甚至到未來四年美股可能的改變
Faker昨天真的太扯了，中國主播王多多點評的話更是精妙，分享給各位
王多多的點評
「Faker是我們的處境，他是LPL永遠繞不開的一個人和話題，所以我們特別渴望在決賽跟他相遇，去直面我們的處境。
我們曾經稱他為最高的山，最長的河，以為山海就是盡頭，可是Faker用他28歲的年齡...
實踐AWS中使用Lambda來負責登入簽核及與OpenAI API溝通，並利用S3容器託管一個靜態網頁做為前端
金融業需遵守金檢規則，建立API分級協助和管理程序確保API合規，使用OAuth 2.0和API KEY授權功能降低風險，實行API認證和金鑰機制保障資料安全。監控API使用，建立控制機制，選擇優良的APIM，提供全面的API管理和安全。
API在網路時代扮演關鍵角色，連結服務與產品，提供便利。了解API的本質，如何連結、提升用戶體驗。企業開放自家API，吸引新客群，提升黏著度。API經濟帶來創新應用，強化競爭力。什麼是API？它是應用程式介面，串接不同應用。發展API經濟的關鍵是什麼？開放！透過開放API整合資源，擴展業務。API經
Axios 如何處理陣列數組資料的傳遞，使用qs套件快速完成吧！
這裡會針 GraphQL 與 RESTful API 這兩者介面所需要做的事情來比較其應用的場景。
Google年初推出的Inspection API，讓我們更容易知道網站被索引的狀況。這篇文章會告訴你，我們怎麼用這支API、發現了什麼。
Google 公開測試 Topics API，有望成為行業新標準？
Meta 推出影音建議指南、YouTube 新增 Shorts 洞察工具
馬斯克停止收購 Twitter！推特將提告？平台專注音訊內容，強化 Space 功能
Pinterest 與 TikTok 增強商務化力度，歐盟卻另有反對意見
續上篇，那是Vue 2 Options API的舊寫法，這邊改成用Vue 3 Composition API的寫法:
Vue2:
Vue3 setup() / ref / reactive
Composition API可以直接在setup()裡面定義data跟method，簡潔許多。
props
這個秋，Chill 嗨嗨！穿搭美美去賞楓，裝備款款去露營⋯⋯你的秋天怎麼過？秋日 To Do List 等你分享！
秋季全站徵文，我們準備了五個創作主題，參賽還有機會獲得「火烤兩用鍋」，一起來看看如何參加吧～
美國總統大選只剩下三天， 我們觀察一整週民調與金融市場的變化（包含賭局）， 到本週五下午3:00前為止， 誰是美國總統幾乎大概可以猜到60-70%的機率， 本篇文章就是以大選結局為主軸來討論近期甚至到未來四年美股可能的改變
Faker昨天真的太扯了，中國主播王多多點評的話更是精妙，分享給各位
王多多的點評
「Faker是我們的處境，他是LPL永遠繞不開的一個人和話題，所以我們特別渴望在決賽跟他相遇，去直面我們的處境。
我們曾經稱他為最高的山，最長的河，以為山海就是盡頭，可是Faker用他28歲的年齡...
實踐AWS中使用Lambda來負責登入簽核及與OpenAI API溝通，並利用S3容器託管一個靜態網頁做為前端
金融業需遵守金檢規則，建立API分級協助和管理程序確保API合規，使用OAuth 2.0和API KEY授權功能降低風險，實行API認證和金鑰機制保障資料安全。監控API使用，建立控制機制，選擇優良的APIM，提供全面的API管理和安全。
API在網路時代扮演關鍵角色，連結服務與產品，提供便利。了解API的本質，如何連結、提升用戶體驗。企業開放自家API，吸引新客群，提升黏著度。API經濟帶來創新應用，強化競爭力。什麼是API？它是應用程式介面，串接不同應用。發展API經濟的關鍵是什麼？開放！透過開放API整合資源，擴展業務。API經
Axios 如何處理陣列數組資料的傳遞，使用qs套件快速完成吧！
這裡會針 GraphQL 與 RESTful API 這兩者介面所需要做的事情來比較其應用的場景。
Google年初推出的Inspection API，讓我們更容易知道網站被索引的狀況。這篇文章會告訴你，我們怎麼用這支API、發現了什麼。
Google 公開測試 Topics API，有望成為行業新標準？
Meta 推出影音建議指南、YouTube 新增 Shorts 洞察工具
馬斯克停止收購 Twitter！推特將提告？平台專注音訊內容，強化 Space 功能
Pinterest 與 TikTok 增強商務化力度，歐盟卻另有反對意見
續上篇，那是Vue 2 Options API的舊寫法，這邊改成用Vue 3 Composition API的寫法:
Vue2:
Vue3 setup() / ref / reactive
Composition API可以直接在setup()裡面定義data跟method，簡潔許多。
props