最佳實踐1:儘量以對瀏覽器友好的方式設計REST API
在設計REST API時,即使面向的消費者是程式而不是人類使用者,也應該儘量以對瀏覽器友好的方式來設計。 那麼什麼叫做“對瀏覽器友好”呢?“對瀏覽器友好”的意思是說:僅僅使用瀏覽器+HTML就可以方便地對REST API做測試。 大家知道,HTML表單僅僅支援GET和POST兩種HTTP方法,不支援PUT/DELETE方法。然而操作伺服器端的資源,僅僅有GET/POST兩種方法是不完備的,必須要實現PUT/DELETE方法。 為了解決這兩者之間的矛盾,聰明的REST開發框架的設計師想出了一個辦法。就是通過在HTML表單中加入一個“_method”隱藏欄位,來模擬PUT/DELETE方法。 例如:當REST開發框架接收到一個HTTP POST請求,它發現其中有一個_method=put的引數,那麼它就會將這個請求等同於一個HTTP PUT請求。
這樣設計帶來的好處,就是REST API既可以使用程式來驅動,也可以使用HTML來驅動,因此測試起來非常方便。在測試的過程中,還可以藉助Firebug之類的除錯工具來檢視請求/響應的內容、以及快取是否生效。 如果使用HTTP Basic Authentication或者HTTP Digest Authentication方式對消費者做身份認證,瀏覽器對這兩種身份認證方式有很好的支援。可以確信,只要使用瀏覽器測試沒有問題,伺服器端的實現與任何支援Basic/Digest身份認證的HTTP客戶端庫配合工作也不會有問題。
相關文章
- 13 個設計 REST API 的最佳實踐RESTAPI
- SpringBoot優雅開發REST API最佳實踐Spring BootRESTAPI
- 設計出色API的最佳實踐與原則 - JamesAPI
- 瀏覽器全屏API瀏覽器API
- 瀏覽器架構-實踐篇瀏覽器架構
- 阿里研究員谷樸:API 設計最佳實踐的思考阿里API
- Java的API設計實踐JavaAPI
- Min瀏覽器: 更快更輕量瀏覽器瀏覽器
- 來自Google資深工程師的API設計最佳實踐Go工程師API
- Fetch 代替 Ajax 的瀏覽器 API瀏覽器API
- 設計微服務的最佳實踐微服務
- 瀏覽器路由 API 詳解瀏覽器路由API
- RESTful API 最佳實踐RESTAPI
- restful api最佳實踐RESTAPI
- vivo瀏覽器的快速開發平臺實踐-總覽篇瀏覽器
- rest-api設計風格RESTAPI
- 以對話的方式擴充套件架構的實踐 - Andrew套件架構
- MaxCompute表設計最佳實踐
- 瀏覽器之爭:程式設計師眼裡瀏覽器的地位 IE:我開了!瀏覽器程式設計師
- 瀏覽器之爭:程式設計師眼裡瀏覽器的地位IE:我開了!瀏覽器程式設計師
- 重學瀏覽器(1)-多程式多執行緒的瀏覽器瀏覽器執行緒
- win10怎麼設定預設瀏覽器 三種方式修改預設遊覽器Win10瀏覽器
- 開放API閘道器實踐(一) ——設計一個API閘道器API
- 綜合Twitter、Github等各大網站API設計經驗:RESTful API實用設計與最佳實踐 - Vinay SahniGithub網站APIREST
- programmer-browser:專為程式設計師設計的瀏覽器程式設計師瀏覽器
- 設定Windows主機的瀏覽器為wls2的預設瀏覽器Windows瀏覽器
- 高併發文章瀏覽量計數系統設計
- 適用於SaaS初創公司的REST API的一系列模式和最佳實踐 - alexkruppRESTAPI模式
- react 設計模式與最佳實踐React設計模式
- 微信跳轉瀏覽器提示,微信瀏覽器中直接跳轉手機預設瀏覽器是怎麼實現的瀏覽器
- 瀏覽器語音桌面通知,Notification API瀏覽器API
- OpenResty 最佳實踐 (1)REST
- 7個API安全最佳實踐API
- 程式設計師眼中瀏覽器什麼樣?程式設計師瀏覽器
- 程式設計技巧│瀏覽器 Notification 桌面推送通知程式設計瀏覽器
- 深入瞭解Kubernetes REST API的工作方式RESTAPI
- 資料庫設計的十個最佳實踐資料庫
- Java程式設計師的八個最佳實踐Java程式設計師
- 場景對瀏覽器的自適應瀏覽器