webAPI接口和restful的介紹和使用-創(chuàng)新互聯(lián)

今天就跟大家聊聊有關(guān)web API接口和restful的介紹和使用，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。

網(wǎng)站建設(shè)哪家好，找創(chuàng)新互聯(lián)建站！專注于網(wǎng)頁(yè)設(shè)計(jì)、網(wǎng)站建設(shè)、微信開(kāi)發(fā)、小程序制作、集團(tuán)企業(yè)網(wǎng)站建設(shè)等服務(wù)項(xiàng)目。為回饋新老客戶創(chuàng)新互聯(lián)還提供了昌圖免費(fèi)建站歡迎大家使用！

什么是web API接口？

明確了請(qǐng)求方式，提供對(duì)應(yīng)后臺(tái)所需參數(shù)，請(qǐng)求url鏈接可以得到后臺(tái)的響應(yīng)數(shù)據(jù)

請(qǐng)求方式：get，post,put,patch....
請(qǐng)求參數(shù)：json或xml格式的key-value類型數(shù)據(jù)
響應(yīng)結(jié)果：返回json或xml格式的key-value類型數(shù)據(jù)

怎么寫接口？

參照某種規(guī)則（規(guī)范）書寫url鏈接，同時(shí)根據(jù)規(guī)則制定請(qǐng)求方式，請(qǐng)求數(shù)據(jù)與響應(yīng)結(jié)果

接口規(guī)范：webapi接口規(guī)范：restful

RESTful介紹

REST與技術(shù)無(wú)關(guān)，代表的是一種軟件架構(gòu)風(fēng)格，REST是Representational State Transfer的簡(jiǎn)稱，中文翻譯為“表征狀態(tài)轉(zhuǎn)移”或“表現(xiàn)層狀態(tài)轉(zhuǎn)化”。

域名

用api關(guān)鍵字來(lái)標(biāo)識(shí)接口url

https://api.example.com
https://example.org/api/

注：看到api字眼，就代表該請(qǐng)求url鏈接是完成前后臺(tái)數(shù)據(jù)交互的

版本

1. 將版本信息放在URL中，如：

https://api.example.com/v1/
https://api.example.com/v2/

v1，v2代表不同數(shù)據(jù)版本的提現(xiàn)，前提是一種數(shù)據(jù)資源有多個(gè)版本

2. 將版本信息放在請(qǐng)求頭中。

url路徑

視網(wǎng)絡(luò)上任何東西都是資源，均使用名詞表示（一般為復(fù)數(shù)形式）

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

在url鏈接中獎(jiǎng)勵(lì)不要出現(xiàn)操作資源的動(dòng)詞

錯(cuò)誤示范：https://api.baidu.com/delete-user

特殊的接口可以出現(xiàn)動(dòng)詞，因?yàn)檫@些接口一般沒(méi)有一個(gè)明確的資源，或是動(dòng)詞就是接口的核心含義

https://api.baidu.com/place/search
https://api.baidu.com/login

method請(qǐng)求方式

GET ：從服務(wù)器取出資源（一項(xiàng)或多項(xiàng)）

POST ：在服務(wù)器新建一個(gè)資源

PUT ：在服務(wù)器更新資源（客戶端提供改變后的完整資源）

PATCH ：在服務(wù)器更新資源（客戶端提供改變的屬性）

DELETE ：從服務(wù)器刪除資源

過(guò)濾

通過(guò)在url上傳參的形式傳遞搜索條件

https://api.example.com/v1/zoos?limit=10：指定返回記錄的數(shù)量
https://api.example.com/v1/zoos?offset=10：指定返回記錄的開(kāi)始位置
https://api.example.com/v1/zoos?page=2&per_page=100：指定第幾頁(yè)，以及每頁(yè)的記錄數(shù)
https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回結(jié)果按照哪個(gè)屬性排序，以及排序順序
https://api.example.com/v1/zoos?animal_type_id=1：指定篩選條件

狀態(tài)碼

200 OK - [GET]：服務(wù)器成功返回用戶請(qǐng)求的數(shù)據(jù)，該操作是冪等的（Idempotent）。

201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功。

202 Accepted - [*]：表示一個(gè)請(qǐng)求已經(jīng)進(jìn)入后臺(tái)排隊(duì)（異步任務(wù)）

204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功。

301：永久重定向

302：暫時(shí)重定向

400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請(qǐng)求有錯(cuò)誤，服務(wù)器沒(méi)有進(jìn)行新建或修改數(shù)據(jù)的操作，該操作是冪等的。

401 Unauthorized - [*]：表示用戶沒(méi)有權(quán)限（令牌、用戶名、密碼錯(cuò)誤）。

403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯(cuò)誤相對(duì)），但是訪問(wèn)是被禁止的。

404 NOT FOUND - [*]：用戶發(fā)出的請(qǐng)求針對(duì)的是不存在的記錄，服務(wù)器沒(méi)有進(jìn)行操作，該操作是冪等的。

406 Not Acceptable - [GET]：用戶請(qǐng)求的格式不可得（比如用戶請(qǐng)求JSON格式，但是只有XML格式）。

410 Gone -[GET]：用戶請(qǐng)求的資源被永久刪除，且不會(huì)再得到的。

422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個(gè)對(duì)象時(shí)，發(fā)生一個(gè)驗(yàn)證錯(cuò)誤。

500 INTERNAL SERVER ERROR - [*]：服務(wù)器發(fā)生錯(cuò)誤，用戶將無(wú)法判斷發(fā)出的請(qǐng)求是否成功。

錯(cuò)誤處理

狀態(tài)碼是4xx時(shí)，應(yīng)返回錯(cuò)誤信息，error當(dāng)做key?！　　　?/p>

{
    error: "Invalid API key"
}

返回結(jié)果

針對(duì)不同操作，服務(wù)器向用戶返回的結(jié)果應(yīng)該符合以下規(guī)范

GET /collection：返回資源對(duì)象的列表（數(shù)組）

GET /collection/resource：返回單個(gè)資源對(duì)象

POST /collection：返回新生成的資源對(duì)象

PUT /collection/resource：返回完整的資源對(duì)象

PATCH /collection/resource：返回完整的資源對(duì)象

DELETE /collection/resource：返回一個(gè)空文檔

{
    "status": 0,
    "msg": "ok",
    "results":[
        {
            "name":"肯德基(羅餐廳)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月羅路2380號(hào)",
            "province":"上海市",
            "city":"上海市",
            "area":"寶山區(qū)",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
        ...
        ]
}

Hypermedia API

RESTful API最好做到Hypermedia，即返回結(jié)果中提供鏈接，連向其他API方法，使得用戶不查文檔，也知道下一步應(yīng)該做什么。

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

看完上述內(nèi)容，你們對(duì)web API接口和restful有進(jìn)一步的了解嗎？如果還想了解更多相關(guān)內(nèi)容，歡迎關(guān)注創(chuàng)新互聯(lián)成都網(wǎng)站設(shè)計(jì)公司行業(yè)資訊頻道，感謝各位的閱讀。

另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn，海內(nèi)外云服務(wù)器15元起步，三天無(wú)理由+7*72小時(shí)售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢(shì)，專為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場(chǎng)景需求。

新聞標(biāo)題：webAPI接口和restful的介紹和使用-創(chuàng)新互聯(lián)
標(biāo)題URL：http://bm7419.com/article8/diosop.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供ChatGPT、網(wǎng)站排名、網(wǎng)站維護(hù)、搜索引擎優(yōu)化、靜態(tài)網(wǎng)站、App開(kāi)發(fā)

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源：創(chuàng)新互聯(lián)

猜你還喜歡下面的內(nèi)容