02 restful接口規範

restful接口規範

接口規範：就是爲了採用不一樣的後臺語言，也能使用一樣的接口獲取到一樣的數據

如何寫接口：接口規範是 規範化書寫接口的，寫接口要寫 url、響應數據

        注：若是將請求參數也歸入考量範圍，那就是在寫 接口文檔

兩大部分：

• url

1) 用api關鍵字標識接口url
    api.baidu.com | www.baidu.com/api
    
2) 接口數據安全性決定優先選擇https協議

3) 若是一個接口有多版本存在，須要在url中標識體現
    api.baidu.com/v1/... | api.baidu.com/v2/...
    
4) 接口操做的數據源稱之爲 資源，在url中通常採用資源複數形式，一個接口能夠歸納對該資源的多種操做方式
    api.baidu.com/books | api.baidu.com/books/(pk)
    
5) 請求方式有多種，用一個url處理如何保證不混亂 - 經過請求方式標識操做資源的方式
    /books         get            獲取全部/獲取一個
    /books         post           增長一個(多個)
    /books/(pk)    delete         刪除一個     params傳參    
    /books/(pk)    put            總體更新一個
    /books/(pk)    patch          局部更新一個

6) 資源每每涉及數據的各類操做方式 - 篩選、排序、限制
    api.baidu.com/books/?search=西&ordering=-price&limit=3

• 響應數據 就是下面的JsonResponse，返回給前端的數據

1) http請求的響應會有響應狀態碼，接口用來返回操做的資源數據，能夠擁有 操做數據結果的 狀態碼
    status  0(操做資源成功)  1(操做資源失敗)  2(操做資源成功，但沒匹配結果)
    注：資源狀態碼不像http狀態碼，通常都是後臺與前臺或是客戶約定的
    
2) 資源的狀態碼文字提示
    status  ok    '帳號有誤'  '密碼有誤'  '用戶鎖定'
    
3) 資源自己
    results
    注：刪除資源成功不作任何數據返回(返回空字符串)
    
4) 不能直接放回的資源(子資源、圖片、視頻等資源)，返回該資源的url連接