1. 程式人生 > >Django restful 規範

Django restful 規範

順序 協議 pos api設計 ctu red com 問題 represent

一、REST Frame Work
  • REST與技術無關,代表的是一種軟件架構風格,REST是Representational State Transfer的簡稱,中文翻譯為“表征狀態轉移”

  • REST從資源的角度類審視整個網絡,它將分布在網絡中某個節點的資源通過URL進行標識,客戶端應用通過URL來獲取資源的表征,獲得這些表征致使這些應用轉變狀態

  • REST與技術無關,代表的是一種軟件架構風格,REST是Representational State Transfer的簡稱,中文翻譯為“表征狀態轉移”

  • 所有的數據,不過是通過網絡獲取的還是操作(增刪改查)的數據,都是資源,將一切數據視為資源是REST區別與其他架構風格的最本質屬性

  • 對於REST這種面向資源的架構風格,有人提出一種全新的結構理念,即:面向資源架構(ROA:Resource Oriented Architecture)

?
二、restful 規範 接口設計
?

  1. API與用戶的通信協議,總是使用HTTPs協議。(樓主窮 HTTP協議)

  2. 域名
    https://api.example.com 盡量將API部署在專用域名(跨域問題、會發送二次請求)
    https://yuan.cn/api/ 建議使用這樣的省錢、簡單的API設計

  3. 版本
    URL,如:https://api.example.com/v1/

  4. 請求頭 跨域時,引發發送多次請求

  5. 路徑,視網絡上任何東西都是資源,均使用名詞表示(可復數)

    https://api.example.com/v1/zoos
    https://api.example.com/v1/animals
    https://api.example.com/v1/employees

  6. method
    GET :從服務器取出資源(一項或多項)
    POST :在服務器新建一個資源
    PUT :在服務器更新資源(客戶端提供改變後的完整資源)(全部更改)
    PATCH :在服務器更新資源(客戶端提供改變的屬性)(用戶可能只需要改其中的一部分,如密碼、密保問題、郵箱這樣,不需要全部更改)
    DELETE :從服務器刪除資源

  7. 過濾,通過在url上傳參的形式傳遞搜索條件
    https://api.example.com/v1/zoos?limit=10:指定返回記錄的數量

    https://api.example.com/v1/zoos?offset=10:指定返回記錄的開始位置
    https://api.example.com/v1/zoos?page=2&per_page=100:指定第幾頁,以及每頁的記錄數
    https://api.example.com/v1/zoos?sortby=name&order=asc:指定返回結果按照哪個屬性排序,以及排序順序
    https://api.example.com/v1/zoos?animal_type_id=1:指定篩選條件

Django restful 規範