今天就跟大家聊聊有關(guān)如何根據(jù)豆瓣api來理解Restful API設(shè)計的，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。
創(chuàng)新互聯(lián)公司-專業(yè)網(wǎng)站定制、快速模板網(wǎng)站建設(shè)、高性價比新區(qū)網(wǎng)站開發(fā)、企業(yè)建站全套包干低至880元,成熟完善的模板庫,直接使用。一站式新區(qū)網(wǎng)站制作公司更省心,省錢,快速模板網(wǎng)站建設(shè)找我們，業(yè)務(wù)覆蓋新區(qū)地區(qū)。費用合理售后完善，十載實體公司更值得信賴。
REST全稱是Representational State Transfer,表述狀態(tài)轉(zhuǎn)移的意思。它是在Roy Fielding博士論文首次提出。REST本身沒有創(chuàng)造新的技術(shù)、組件或服務(wù)，它的理念就是在現(xiàn)有的技術(shù)之上，更好的使用現(xiàn)有的 web規(guī)范。用REST規(guī)范的web服務(wù)器，能夠更好的展現(xiàn)資源，客戶端能夠更好的使用資源。每個資源都由URI/ID標識。REST本身跟http無關(guān)，但是目前http是與它相關(guān)的唯一實例。REST有著優(yōu)雅、簡潔的特性，本文是根據(jù)豆瓣api來談?wù)勛约簩estful的一些理解。
URI(Uniform Resource Identifiers) 統(tǒng)一資源標示符
URL(Uniform Resource Locator) 統(tǒng)一資源定位符
URI 的格式：
URI的格式定義如下： URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]
uri代表的是一種資源，要做到優(yōu)雅、簡潔。
最好在api地址標明版本
比如
https://api.douban.com/v2
關(guān)于分隔符“／”，比如：
"/"分隔符一般用來對資源層級的劃分,比如： https://api.douban.com/v2/book/1220562 表述了豆瓣api，version2下的圖書倉庫下的編號為1220562的圖書。
URI盡量使用“-”代替下劃線“_“。
URI統(tǒng)一使用小寫字母
URI不包含文件擴展名
使用？用來過濾資源，比如？limit=10 :指定返回10條記錄。
不使用無意義的字符串、數(shù)字，要做到簡潔。
get -只用做資源的讀取。
post-通過用作創(chuàng)建一個新的資源。
delete-通過用作資源的刪除。
put -通過用作更新資源或者創(chuàng)建資源
head-只獲取某個資源的頭部信息。
比如 豆瓣圖書api：
| name | method | api |
|---|---|---|
| 獲取圖書信息 | get | /v2/book/:id |
| 用戶收藏某本圖書 | post | /v2/book/:id/collection |
| 用戶修改對某本圖書的收藏 | put | /v2/book/:id/collection |
| 用戶刪除對某個圖書的收藏 | delete | /v2/book/:id/collection |
另外，在一些不符合curd的情況下，使用 post。
把動作轉(zhuǎn)換成資源
比如，上述接口中，用戶收藏某本書對外暴露的接口是”/v2/book/:id/collection”,收藏動作通過post方法來展現(xiàn)，而不直接寫著api中，collection “收藏”，名次，動作直接轉(zhuǎn)換成了資源。
http請求需要返回狀態(tài)碼，約定俗成的狀態(tài)碼能夠幫助開發(fā)團隊提高溝通效率。
2xx: 請求正常處理并返回
3xx: 重定向
4xx: 客戶端請求有錯誤
5xx: 服務(wù)端請求有錯誤
比如豆瓣api返回的狀態(tài)碼說明：
| 狀態(tài)碼 | 含義 | 說明 |
|---|---|---|
| 200 | ok | 請求成功 |
| 201 | created | 創(chuàng)建成功 |
| 202 | accepted | 更新成功 |
| 400 | bad request | 請求不存在 |
| 401 | unauthorized | 未授權(quán) |
| 403 | forbidden | 禁止訪問 |
| 404 | not found | 資源不存在 |
| 500 | internal server error | 內(nèi)部錯誤 |
通用錯誤碼，具體產(chǎn)品由具體產(chǎn)品api給出。比如豆瓣api:
| 錯誤碼 | 錯誤信息 | 含義 |
|---|---|---|
| 999 | unknow_v2_error | 未知錯誤 |
| 1000 | need_permission | 需要權(quán)限 |
| 1001 | uri_not_found | 資源不存在 |
| … | …. | … |
太多了，只列出幾條，具體見豆瓣 api。
這部分內(nèi)容不屬于這篇文章，但是稍微說明下：
使用https
使用jwt驗證
使用參數(shù)簽名，防止參數(shù)被篡改。
使用權(quán)限驗證，shiro ,或者自己建數(shù)據(jù)庫（用戶、角色、權(quán)限）
接口文檔的編寫至關(guān)重要，最好是寫一個在線接口文檔。接口文檔能夠方便團隊查閱，減少不必要的溝通。如果對外公開api，api文檔的質(zhì)量直接反應(yīng)了一個公司的技術(shù)水平，甚至一個公司的文化氣質(zhì)。
看完上述內(nèi)容，你們對如何根據(jù)豆瓣api來理解Restful API設(shè)計的有進一步的了解嗎？如果還想了解更多知識或者相關(guān)內(nèi)容，請關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，感謝大家的支持。
重慶分公司
重慶分公司
