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] 複數參數用
12會員
23內容數
這一系列是我的讀書心得，也算是一個擷取書中精華的書摘。
希望可以讓你對這些書有興趣，到書店看到它可以拿起來看一看~
甚至也可以讓你因此推薦更多相似或者也是很棒的作品給我：)
留言0
查看全部
你可能也想看
Google News 追蹤
隨著理財資訊的普及，越來越多台灣人不再將資產侷限於台股，而是將視野拓展到國際市場。特別是美國市場，其豐富的理財選擇，讓不少人開始思考將資金配置於海外市場的可能性。
然而，要參與美國市場並不只是盲目跟隨標的這麼簡單，而是需要策略和方式，尤其對新手而言，除了選股以外還會遇到語言、開戶流程、Ap
嘿，大家新年快樂~ 新年大家都在做什麼呢？
跨年夜的我趕工製作某個外包設計案，在工作告一段落時趕上倒數。
然後和兩個小孩過了一個忙亂的元旦。在深夜時刻，看到朋友傳來的解籤網站，興致勃勃熬夜體驗了一下，覺得非常好玩，或許有人玩過了，但還是想寫上來分享紀錄一下~
API（Application Programming Interface，應用程式介面）可以視為不同軟體系統之間的溝通橋梁，讓雙邊可以交換數據並執行各種功能。這篇會記錄產品經理一定要知道的幾個 API 概念，像是常見的錯誤代碼以及不同的 HTTP 方法（如 PUT、GET、POST）和實際案例說明
※ 什麼是Web API
API 就是後端開出來讓前端來用的介面，讓前端與後端可以溝通。
API流程：
終端使用者用任何一種裝置進入瀏覽器。
瀏覽器透過 API 向後端發出請求，請求查詢或修改資料。
後端透過 API 收到前端的請求後，取得資料並回應給前端。
前端渲染畫面，終端使用者
※ Params是什麼？
在網頁開發中，params代表的是參數（Parameters）。當你在路由（Route）中定義了一個或多個變數時，這些變數的值就會被存儲在 params 對象中。所以，params 就是用來存儲路由參數的地方，這些參數可以在處理請求時使用。
※ Params的兩個功能：
※ 什麼是 RESTful API？
這種運用 HTTP 來表達語義的路由設計風格稱為 RESTful API，它描述了如何實現 Web API 的架構。所謂的 API 是應用程式介面 (application programming interface)，網址也是一種應用程式的「介面」，故稱為
在API介接中使用x-www-form-urlencoded格式時，可能會遇到一些踩坑的情況，本文分享了作者在這方面遇到的問題和解決方法。
在開發前後端分離架構時，使用兩個不同網域所遇到跨域請求問題。特別是在POST請求時行為差異大，揭示了「簡單請求」與「預檢請求」的關鍵差異。簡單請求不需預檢，但application/json會觸發預檢請求，需透過特定設定解決。分享這篇文章希望幫助開發者有效處理跨域問題。
當這產品的這個 API 被呼叫，再從回傳內容的某個欄位欄位來判斷，只要“這個欄位”顯示 false 就代表不支援」，雖然這樣的設計也能滿足功能需求…
之前分享過【網路請求帶參數的方式】，開發者可以透過 URL 代入參數，來向伺服器請求特定的資源，我們當然也可以擷取 URL 的內容，來做為後續開發的判斷條件，這篇就來記錄一下，網址(URL) 和域名(Domain) 是什麼，以及如何取得網址的參數吧！
我們常說的網址連結 URL 完整名稱是 U
先前幾篇筆記介紹了網路請求，瀏覽器儲存資料的方式，那麼實務上，前端最常需要發送網路請求的時候，就是透過呼叫 API，去向後端工程師發送/請求資料，所以今天來記錄什麼是 API吧！
發送表單用get跟post看起來好像都無所謂，然而事實並非如此，使用GET的風險如下：
安全性問題
機密資訊為何不宜用GET，是因為由GET方法提交的表單會將欄位的key,value顯示於URL上，想像一下如果小明借用你的電腦，查看你的網頁歷史紀錄時就可以看到你的帳密了，多可怕！
再來就是如果
隨著理財資訊的普及，越來越多台灣人不再將資產侷限於台股，而是將視野拓展到國際市場。特別是美國市場，其豐富的理財選擇，讓不少人開始思考將資金配置於海外市場的可能性。
然而，要參與美國市場並不只是盲目跟隨標的這麼簡單，而是需要策略和方式，尤其對新手而言，除了選股以外還會遇到語言、開戶流程、Ap
嘿，大家新年快樂~ 新年大家都在做什麼呢？
跨年夜的我趕工製作某個外包設計案，在工作告一段落時趕上倒數。
然後和兩個小孩過了一個忙亂的元旦。在深夜時刻，看到朋友傳來的解籤網站，興致勃勃熬夜體驗了一下，覺得非常好玩，或許有人玩過了，但還是想寫上來分享紀錄一下~
API（Application Programming Interface，應用程式介面）可以視為不同軟體系統之間的溝通橋梁，讓雙邊可以交換數據並執行各種功能。這篇會記錄產品經理一定要知道的幾個 API 概念，像是常見的錯誤代碼以及不同的 HTTP 方法（如 PUT、GET、POST）和實際案例說明
※ 什麼是Web API
API 就是後端開出來讓前端來用的介面，讓前端與後端可以溝通。
API流程：
終端使用者用任何一種裝置進入瀏覽器。
瀏覽器透過 API 向後端發出請求，請求查詢或修改資料。
後端透過 API 收到前端的請求後，取得資料並回應給前端。
前端渲染畫面，終端使用者
※ Params是什麼？
在網頁開發中，params代表的是參數（Parameters）。當你在路由（Route）中定義了一個或多個變數時，這些變數的值就會被存儲在 params 對象中。所以，params 就是用來存儲路由參數的地方，這些參數可以在處理請求時使用。
※ Params的兩個功能：
※ 什麼是 RESTful API？
這種運用 HTTP 來表達語義的路由設計風格稱為 RESTful API，它描述了如何實現 Web API 的架構。所謂的 API 是應用程式介面 (application programming interface)，網址也是一種應用程式的「介面」，故稱為
在API介接中使用x-www-form-urlencoded格式時，可能會遇到一些踩坑的情況，本文分享了作者在這方面遇到的問題和解決方法。
在開發前後端分離架構時，使用兩個不同網域所遇到跨域請求問題。特別是在POST請求時行為差異大，揭示了「簡單請求」與「預檢請求」的關鍵差異。簡單請求不需預檢，但application/json會觸發預檢請求，需透過特定設定解決。分享這篇文章希望幫助開發者有效處理跨域問題。
當這產品的這個 API 被呼叫，再從回傳內容的某個欄位欄位來判斷，只要“這個欄位”顯示 false 就代表不支援」，雖然這樣的設計也能滿足功能需求…
之前分享過【網路請求帶參數的方式】，開發者可以透過 URL 代入參數，來向伺服器請求特定的資源，我們當然也可以擷取 URL 的內容，來做為後續開發的判斷條件，這篇就來記錄一下，網址(URL) 和域名(Domain) 是什麼，以及如何取得網址的參數吧！
我們常說的網址連結 URL 完整名稱是 U
先前幾篇筆記介紹了網路請求，瀏覽器儲存資料的方式，那麼實務上，前端最常需要發送網路請求的時候，就是透過呼叫 API，去向後端工程師發送/請求資料，所以今天來記錄什麼是 API吧！
發送表單用get跟post看起來好像都無所謂，然而事實並非如此，使用GET的風險如下：
安全性問題
機密資訊為何不宜用GET，是因為由GET方法提交的表單會將欄位的key,value顯示於URL上，想像一下如果小明借用你的電腦，查看你的網頁歷史紀錄時就可以看到你的帳密了，多可怕！
再來就是如果