天天看點

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

全稱:表述性狀态轉移 (Representational State Transfer), 将資源的狀态以最适合用戶端或服務端的形式從伺服器端轉移到用戶端(或者反過來)。

面向資源,而不是面向行為

資源通過URL進行識别和定位,

一般URL中都使用名詞,不使用動詞

對資源采取的行為使用HTTP方法來定義,如GET, POST, DELETE, PUT

以使用者增删改查為例,設計 REST API.

這裡,我們主要關注Spring Mvc中的Controller的設計:

UserController類:

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

這裡使用了@RestController注解,Spring将會為該Controller的所有處理方法應用消息轉換功能,是以我們可以不必為每個方法都添加@ResponseBody。

Spring支援多種資源表述形式(JSON/XML/HTML...),不過一般使用JSON形式。

對應請求的URL示例(無分頁):http://localhost:8080/webbf/users

對應的URL示例(有分頁):http://localhost:8080/webbf/users?offset=0&limit=10

使用的HTTP方法:GET

如果查詢不到使用者,傳回狀态碼204,No Content

否則,傳回狀态碼200, OK,傳回的資料類型為 application/json;charset=utf-8

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

對應請求的URL示例:http://localhost:8080/webbf/users/1

如果查詢不到使用者,傳回狀态碼404,Not Found

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

使用的HTTP方法:DELETE

如果查詢不到被删除的使用者,傳回狀态碼404,Not Found

否則,删除成功,傳回狀态碼204, No Content

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

對應請求的URL示例:http://localhost:8080/webbf/users

請求體:

{

    "name":"1",

    "address":"aa"

}

Content-Type: application/json

使用的HTTP方法:POST

響應的body為新建立的使用者;

響應頭的Location:http://localhost:8080/webbf/users/60

//如果使用者已存在,傳回狀态碼,409, Conflict

儲存成功,傳回狀态碼201, Created,傳回的資料類型為 application/json;charset=utf-8

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

使用的HTTP方法:PUT

如果查詢不到被修改的使用者,傳回狀态碼404,Not Found

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

請求中發生異常,傳回500 Internal Server Error。

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

因為我喜歡用fireFox, 是以我用restclient測試工具測試 REST API:

chrom的話,可以使用Postman。

Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例
Spring 4 建立REST API什麼是RESTSpring MVC REST API示例前端測試工具前端AJAX調用 REST API 示例

<a></a>

<a>本文轉自風一樣的碼農部落格園部落格,原文連結:http://www.cnblogs.com/chenpi/p/6126153.html,如需轉載請自行聯系原作者</a>