RESTfull API
REST(英文:Representational State Transfer,簡稱REST)描述了一個架構樣式的網路系統,比如 web 應用程式。它首次出現在 2000 年 Roy Fielding 的博士論文中,Roy Fielding是 HTTP 規範的主要編寫者之一。在目前主流的三種Web服務互動方案中,REST相比於SOAP(Simple Object Access protocol,簡單物件訪問協議)以及XML-RPC更加簡單明瞭,無論是對URL的處理還是對Payload的編碼,REST都傾向於用更加簡單輕量的方法設計和實現。值得注意的是REST並沒有一個明確的標準,而更像是一種設計的風格透過RESTful API實現,學生操作具體介面如下
操作 |
REST ACTION |
API | ||
新增學生 |
POST |
/api/business/students | ||
獲取學生詳情 |
GET |
/api/business/students/id | ||
修改學生 |
PATCH |
/api/business/students/id |
DELETE |
/api/business/students |
查詢學生 |
GET |
/api/business/students |
通過後臺元資料管理UI設計學生表字段,主要包括名稱,學號,年齡,專業等欄位
基本屬性物件名稱唯一識別不同的物件,物件複數用於URL路徑中的資源,物理表名稱最終為資料庫中的表名欄位屬性主要包括:名稱,型別,索引,長度,精度等
表設計
更多屬性包括:是否可以為空,預設值,是否可以插入,是否可以編輯,是否可以查詢等
更多屬性
資料庫透過檢視mysql資料庫,學生表ca_student已經生成
mysql
swagger
以建立為例:/api/business/{name},其中name為物件名稱複數形式(相容物件名稱)
業務資料透過post man驗證API建立學生postman
請求body
{ "name":"諸葛亮", "stuNo":"10000", "age":18, "major":"計算機科學與技術"}
返回值1為id
查詢id為1的學生詳情獲取學生詳情
返回body
{ "id": 1, "name": "諸葛亮", "createdDate": 1613013249000, "stuNo": "10000", "age": 18, "major": "計算機科學與技術"}
透過UI操作建立學生ui建立學生
獲取所有學生列表查詢學生列表
小結本文透過配置表單的方式實現了RESTful CRUD API,和傳統開發的方式對比如下:
實現方式 |
程式碼量 |
時間 |
穩定性 |
傳統開發 |
1000行左右 |
2天/人 |
5個bug左右 |
cruapi系統 |
0行 |
1分鐘 |
基本為0
最新評論
|