協議: API與使用者的通訊協議,http,https協議
域名: eg: http://example.com
版本: 如果介面有版本的迭代的話,可以在域名後面拼接版本標識,eg:http://example.com/v1
路徑 又稱終點 endpoint, 表示api的具體網址
在restful架構中,每個網址代表一種資源,所以網址中不能有動詞,只使用名詞且往往與資料庫中的表格名對應。一般資料庫中的表都是同種記錄的集合,所以api中的名詞也應該使用複數。
http動詞,即介面的請求方法,eg: get,post,put(完整更新),patch(部分更新),DELETE, head(獲取資源的後設資料),options(獲取資訊,關於資源的那些屬性是客戶端可以改變的)。
過濾資訊
狀態碼
客戶端的每一次請求,伺服器都必須給出回應,回應包括http狀態碼和資料兩部分。
返回結果
錯誤處理
身份認證
跨域處理
可以在服務端設定cors允許客戶端跨域資源請求,或客戶端設定代理
RESTful 介面設計規範 筆記
相關文章
- restful介面設計規範總結REST
- restFul介面設計規範[僅供參考]REST
- RESTful API 設計規範RESTAPI
- RESTful 介面設計規範與mock的完美結合RESTMock
- 基於工程經驗的『RESTful介面設計規範』REST
- Restful API 的設計規範RESTAPI
- API 介面設計規範API
- Java開發中RestFul服務介面規範JavaREST
- 程式設計小記-程式設計規範程式設計
- Restful介面規約REST
- 後臺介面設計之表格設計規範參考
- 介面自動化指令碼設計規範指令碼
- 聊聊介面測試用例設計規範
- 前端搞設計規範(夭折記)前端
- 後臺介面設計之表單設計規範參考
- 視窗介面設計規範:介面關閉方式及介面疊加
- 專案規範筆記筆記
- 平臺介面建設規範
- drf : web應用模式,RESTful API規範,介面測試工具:PostmanWeb模式RESTAPIPostman
- Restful規範-APIView原始碼分析RESTAPIView原始碼
- Restful 筆記REST筆記
- MySQL資料庫規範 (設計規範+開發規範+操作規範)MySql資料庫
- 名片設計規範
- 【javaWeb】軟體工程課程設計後臺介面規範JavaWeb軟體工程
- MySQL 規範 (資料庫表設計規範)MySql資料庫
- SpringBoot 專案規範筆記.2021Spring Boot筆記
- JS程式設計規範JS程式設計
- RESETful API 設計規範API
- PCB Stack設計規範
- React程式設計規範React程式設計
- Rest Framework設計規範RESTFramework
- python程式設計規範Python程式設計
- 【學習筆記】之:Java命名規範筆記Java
- Golang學習筆記(一):命名規範Golang筆記
- 介面測試--介面文件規範
- Greenplum索引設計的規範索引
- ios12設計規範iOS
- 移動端UI設計規範模板參考以及設計規範的好處UI