API 網址這樣設定有夠棒!

更新於 發佈於 閱讀時間約 3 分鐘

網址是 API 的門面,大家使用 API 的第一步就是要看它。
第一眼就要讓人就知道這隻 API 在做什麼?
甚至因為遵循標準(目前 REST 是主流),可以類推 API 應該會有什麼功能等等。

網址規劃的好,未來隨著需求變化也比較有彈性能夠修改 / 擴充。

raw-image


網址設定跟著這些原則走,輕鬆沒煩惱

1. 命名簡單明瞭

https://api.test.com/products/1234
這個網址代表是一個 api 的位置,這會取得編號 1234 的商品資料 (products)

2. 不要使用過度簡化的單詞

https://api.test.com/p/666
這邊 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] 複數參數用

留言
avatar-img
留言分享你的想法!
avatar-img
Hong的沙龍
12會員
23內容數
這一系列是我的讀書心得,也算是一個擷取書中精華的書摘。 希望可以讓你對這些書有興趣,到書店看到它可以拿起來看一看~ 甚至也可以讓你因此推薦更多相似或者也是很棒的作品給我:)
Hong的沙龍的其他內容
2023/04/01
避免成為流當品需要良好的訓練與堅貞的意志,大部分的人都很難具備。 但是,淪落為流當品還能翻身就比較容易一些!因為刻骨銘心的痛苦經驗以及深切反思結果能讓已失去光芒的人生重新綻放光芒。
Thumbnail
2023/04/01
避免成為流當品需要良好的訓練與堅貞的意志,大部分的人都很難具備。 但是,淪落為流當品還能翻身就比較容易一些!因為刻骨銘心的痛苦經驗以及深切反思結果能讓已失去光芒的人生重新綻放光芒。
Thumbnail
2022/10/17
學習應該有一些重點的! 學習的重點終究要回歸於自己,主要在於提高個人的影響力。 必須找到事半功倍的學習方法,對於職場的而言學習就像是額外增加的工作量,只會讓人感到負擔。 絕對不能躁進,凡事按照『自己的進度』,操之過急只會加速結束
Thumbnail
2022/10/17
學習應該有一些重點的! 學習的重點終究要回歸於自己,主要在於提高個人的影響力。 必須找到事半功倍的學習方法,對於職場的而言學習就像是額外增加的工作量,只會讓人感到負擔。 絕對不能躁進,凡事按照『自己的進度』,操之過急只會加速結束
Thumbnail
2022/06/26
作者是日本精神科醫生:樺澤紫苑 Shion Kabasawa,也是一位每天堅持輸出寫文章的網路部落客,至今都還有在更新:樺沢紫苑公式ブログ
Thumbnail
2022/06/26
作者是日本精神科醫生:樺澤紫苑 Shion Kabasawa,也是一位每天堅持輸出寫文章的網路部落客,至今都還有在更新:樺沢紫苑公式ブログ
Thumbnail
看更多
你可能也想看
Thumbnail
API(Application Programming Interface,應用程式介面)可以視為不同軟體系統之間的溝通橋梁,讓雙邊可以交換數據並執行各種功能。這篇會記錄產品經理一定要知道的幾個 API 概念,像是常見的錯誤代碼以及不同的 HTTP 方法(如 PUT、GET、POST)和實際案例說明
Thumbnail
API(Application Programming Interface,應用程式介面)可以視為不同軟體系統之間的溝通橋梁,讓雙邊可以交換數據並執行各種功能。這篇會記錄產品經理一定要知道的幾個 API 概念,像是常見的錯誤代碼以及不同的 HTTP 方法(如 PUT、GET、POST)和實際案例說明
Thumbnail
※ 什麼是Web API API 就是後端開出來讓前端來用的介面,讓前端與後端可以溝通。 API流程: 終端使用者用任何一種裝置進入瀏覽器。 瀏覽器透過 API 向後端發出請求,請求查詢或修改資料。 後端透過 API 收到前端的請求後,取得資料並回應給前端。 前端渲染畫面,終端使用者
Thumbnail
※ 什麼是Web API API 就是後端開出來讓前端來用的介面,讓前端與後端可以溝通。 API流程: 終端使用者用任何一種裝置進入瀏覽器。 瀏覽器透過 API 向後端發出請求,請求查詢或修改資料。 後端透過 API 收到前端的請求後,取得資料並回應給前端。 前端渲染畫面,終端使用者
Thumbnail
先前幾篇筆記介紹了網路請求,瀏覽器儲存資料的方式,那麼實務上,前端最常需要發送網路請求的時候,就是透過呼叫 API,去向後端工程師發送/請求資料,所以今天來記錄什麼是 API吧!
Thumbnail
先前幾篇筆記介紹了網路請求,瀏覽器儲存資料的方式,那麼實務上,前端最常需要發送網路請求的時候,就是透過呼叫 API,去向後端工程師發送/請求資料,所以今天來記錄什麼是 API吧!
Thumbnail
上一篇我們介紹了模擬API的工具箱「【Mockoon工具箱】awesome API mocking簡介」, 也示範如何模擬回傳資料, 但我們的API通常千變萬化, 尤其是會搭配不同的查詢條件進行資料的抓取,正好Mockoon也提供了Rules的一個功能, 透過規則的設定回應不同的資料內容。 API入
Thumbnail
上一篇我們介紹了模擬API的工具箱「【Mockoon工具箱】awesome API mocking簡介」, 也示範如何模擬回傳資料, 但我們的API通常千變萬化, 尤其是會搭配不同的查詢條件進行資料的抓取,正好Mockoon也提供了Rules的一個功能, 透過規則的設定回應不同的資料內容。 API入
Thumbnail
在上一篇文章介紹過API之後,大家應該會很好奇寫好了一隻API應該怎麼測試巴?
Thumbnail
在上一篇文章介紹過API之後,大家應該會很好奇寫好了一隻API應該怎麼測試巴?
Thumbnail
你想像有一個黑盒子,它會跟你說輸入一個input,而會得出什麼Output,而你要把這個Input傳遞給黑盒子是透過http的方式
Thumbnail
你想像有一個黑盒子,它會跟你說輸入一個input,而會得出什麼Output,而你要把這個Input傳遞給黑盒子是透過http的方式
Thumbnail
Restful API 其實就是開放一個 EndPoit 的網路接口給其他人使用,並將要做的事情封裝在該接口內,不需要知道真實運作狀況,只要得到答案即可。
Thumbnail
Restful API 其實就是開放一個 EndPoit 的網路接口給其他人使用,並將要做的事情封裝在該接口內,不需要知道真實運作狀況,只要得到答案即可。
追蹤感興趣的內容從 Google News 追蹤更多 vocus 的最新精選內容追蹤 Google News