【flask】Restful風格的文章

一、定義

Restful是一種定義API文檔的風格,大白話就是某個功能要叫什麼名字要用什麼方法,不一定要完全遵守,規矩是死的人是活的,完全遵守也是沒有問題。

大部分公司都是前後端分離的,而後端給前端傳什麼數據,變量名是什麼就很有必要去遵守,我曾經套路過很多騷貨教我怎麼寫API,第一是公司信息保密,第二是脫離業務是寫不出API,所以沒有一個騷貨回答過這個問題。

二、主要內容

三、應用場景網易雲課堂

3.1 URI

後臺的Restful API可以這樣寫(我並不知道參數是什麼意思只是舉個例子):

HTTP GET /categoy/{uuid}:前端前一個uuid,用GET方法,後端獲取id={uuid}的課程種類,(後端可以調用:字符串.escape(uuid)僞裝一下信息)後端把信息渲染到前端。

  1. 不能用動詞:就是指不會寫成“HTTP GET /get-categoy/{uuid}”或者是“HTTP GET /get_categoy/{uuid}”不能用下劃線。不能有動詞,有人會槓,那登錄和註冊怎麼辦?登錄和註冊都有名詞形式,而且是它們本身。
  2. 而且URI是使用小寫字母的。
  3. 不要在末尾使用“/”作爲URI路徑中的最後一個字符,正斜槓(/)不會添加語義值,可能導致混淆。

那如此類推:HTTP POST /categoy

Json如下:{

"categoy":"{uuid}"

}

 

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章