我們此次後端api的實現主要是按照RESTful api規範來設計的，就是符合REST架構下設計api的規範。簡單的來說REST結構就是：利用URL定位資源，用HTTP動詞(GET,POST,PUT,DELETE)來描述相應操作。

       RESTful api主要的意義在於它可以讓在不同形式的前端所接受到的使用者請求能夠統一的傳送到一個後臺並返回不同的前端。RESTful api是由後端SERVER實現並提供給前端來呼叫的一個介面。前端呼叫API來向後臺發起HTTP請求，後臺響應請求並將處理結構反饋給前端。所以說RESTful是典型的基於HTTP的協議。所以下面我們對RESTful api

一、協議

       API與使用者的通訊協議，總是使用HTTPs協議。

二、域名

   儘量將API部署在專用域名之下：

   例如https://api.jupiter.com

三、版本

   將我們API的版本號放入URL中：

   例如https://api.jupiter.com/v1/

四、路徑

   路徑又稱"終點"（endpoint），表示API的具體網址。

   在RESTful架構中，每個網址代表一種資源（resource），所以網址中不能有動詞，只能有名詞，而且所用的名詞往往與資料庫的表格名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），所以

    舉例來說，有一個API提供動物園（zoo）的資訊，還包括各種動物和僱員的資訊，則它的路徑應該設計成下面這樣：

          https://api.jupiter.com/zoo

          https://api.jupiter.com/animals

          https://api.jupiter.com/employees

五、HTTP動詞

   對於資源的具體操作型別，由HTTP動詞來表示，常用的HTTP動詞有下面五個(括號中對應的是相應的SQL命令)：

        GET（SELECT）：從伺服器取出資源（一項或多項）。

        POST（

        PUT（UPDATE）：在伺服器更新資源（客戶端提供改變後的完整資源）。

        PATCH（UPDATE）：在伺服器更新資源（客戶端提供改變的屬性）。

        DELETE（DELETE）：從伺服器刪除資源。

        下面是一些簡單的例子：

        GET /zoos：列出所有動物園

        POST /zoos：新建一個動物園

        GET /zoos/ID：獲取某個指定動物園的資訊

        PUT /zoos/ID：更新某個指定動物園的資訊（提供該動物園的全部資訊）

        PATCH /zoos/ID：更新某個指定動物園的資訊（提供該動物園的部分資訊）

        DELETE /zoos/ID：刪除某個動物園

        GET /zoos/ID/animals：列出某個指定動物園的所有動物

        DELETE /zoos/ID/animals/ID：刪除某個指定動物園的指定動物

六、過濾資訊

   如果記錄數量很多，伺服器不可能都將它們返回給使用者。API應該提供引數，過濾返回結果，下面是一些常見的引數：

        ?limit=10：指定返回記錄的數量

        ?offset=10：指定返回記錄的開始位置。

        ?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。

        ?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。

        ?animal_type_id=1：指定篩選條件

   引數的設計允許存在冗餘，即允許API路徑和URL引數偶爾有重複。比如，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。

七、狀態碼

   伺服器向用戶返回的狀態碼和提示資訊，常見的有以下一些（方括號中是該狀態碼對應的HTTP動詞）：

        200 OK - [GET]：伺服器成功返回使用者請求的資料，該操作是冪等的（Idempotent）。

        201 CREATED - [POST/PUT/PATCH]：使用者新建或修改資料成功。

        202 Accepted - [*]：表示一個請求已經進入後臺排隊（非同步任務）

        204 NO CONTENT - [DELETE]：使用者刪除資料成功。

        400 INVALID REQUEST - [POST/PUT/PATCH]：使用者發出的請求有錯誤，伺服器沒有進行新建或修改資料的操作，該操作是冪等的。

        401 Unauthorized - [*]：表示使用者沒有許可權（令牌、使用者名稱、密碼錯誤）。

        403 Forbidden - [*] 表示使用者得到授權（與401錯誤相對），但是訪問是被禁止的。

        404 NOT FOUND - [*]：使用者發出的請求針對的是不存在的記錄，伺服器沒有進行操作，該操作是冪等的。

        406 Not Acceptable - [GET]：使用者請求的格式不可得（比如使用者請求JSON格式，但是隻有XML格式）。

        410 Gone -[GET]：使用者請求的資源被永久刪除，且不會再得到的。

        422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個物件時，發生一個驗證錯誤。

        500 INTERNAL SERVER ERROR - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。

   詳細的狀態碼列表可見這裡。

八、錯誤處理

   如果狀態碼是4xx，就應該向使用者返回出錯資訊。一般來說，返回的資訊中將error作為鍵名，出錯資訊作為鍵值即可。

        例如：

   {
       error: "Invalid API key"
   }

九、返回結果

      針對不同操作，伺服器向用戶返回的結果應該符合以下規範：

      GET /collection：返回資源物件的列表（陣列）

      GET /collection/resource：返回單個資源物件

      POST /collection：返回新生成的資源物件

      PUT /collection/resource：返回完整的資源物件

      PATCH /collection/resource：返回完整的資源物件

      DELETE /collection/resource：返回一個空文件