[TOC] ## 創建模型URI ``` /devices /devices/{id} /configurations /configurations/{id} /devices/{id}/configurations /devices/{id}/configurations/{id} ``` ## 合理設計參數 ``` 比如設計一個最近登陸的所有用戶 https://example.com/api/users?recently_login_day=3 ``` ``` 搜索用戶，并按照注冊時間降序 https://example.com/api/users?recently_login_day=3 ``` ``` 搜索用戶，并按照注冊時間升序、活躍度降序 https://example.com/api/users?q=key&sort=create_title_asc,liveness_desc ``` ``` 分頁 https://api.cnblogs.com/api/blogposts/picked?pageIndex=pageIndex&pageSize=pageSize ``` ## 統一返回數據格式 code * 包含一個整數類型的HTTP響應狀態碼 status * 包含文本：`success`，`fail`或`error`。 * HTTP狀態響應碼在500-599之間為`fail`， * 在400-499之間為`error`， * 其它均為`success`（例如：響應狀態碼為1XX、2XX和3XX） message * 當狀態值為`fail`和`error`時有效，用于顯示錯誤信息 data * 包含響應的body。當狀態值為`fail`或`error`時，data僅包含錯誤原因或異常名稱、或者null也是可以的 * 返回成功的響應json格式 ``` { "code": 200, "message": "success", "data": { "userName": "123456", "age": 16, "address": "beijing" } } ``` * 返回失敗的響應json格式 ``` { "code": 401, "message": "error message", "data": null } ``` ## http狀態碼 1** 請求未成功 2** 請求成功、表示成功處理了請求的狀態代碼。 3** 請求被重定向、表示要完成請求，需要進一步操作。 通常，這些狀態代碼用來重定向。 4** 請求錯誤這些狀態代碼表示請求可能出錯，妨礙了服務器的處理。 5**（服務器錯誤）這些狀態代碼表示服務器在嘗試處理請求時發生內部錯誤。 這些錯誤可能是服務器本身的錯誤，而不是請求出錯。