# Hello，crudapi！（你好，增刪改查介面！）

本文通過學生物件為例，無需程式設計，通過配置實現CRUD RESTful API。

### 概要

#### CRUD簡介
crud是指在做計算處理時的增加(Create)、檢索(Retrieve)、更新(Update)和刪除(Delete)幾個單詞的首字母簡寫。crud主要被用在描述軟體系統中資料庫或者持久層的基本操作功能。

#### 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/id
查詢學生 | GET| /api/business/students

### 表設計

#### 學生欄位設計
通過後臺後設資料管理UI設計學生表欄位，主要包括名稱，學號，年齡，專業等欄位

#### 基本屬性
物件名稱唯一識別不同的物件，物件複數用於URL路徑中的資源，物理表名稱最終為資料庫中的表名  
欄位屬性主要包括：名稱，型別，索引，長度，精度等
![學生表設計](https://help.crudapi.cn/img/metadata/helloworld/student.png)

#### 更多屬性
包括：是否可以為空，預設值，是否可以插入，是否可以編輯，是否可以查詢等
![學生表設計更多欄位](https://help.crudapi.cn/img/metadata/helloworld/more.png)

#### 資料庫
通過檢視mysql資料庫，學生表ca_student已經生成
![mysql ca_student](https://help.crudapi.cn/img/metadata/helloworld/mysql.png)

#### Swagger API文件
[https://demo.crudapi.cn/swagger-ui.html](https://demo.crudapi.cn/swagger-ui.html)

![Swagger](https://help.crudapi.cn/img/metadata/helloworld/swagger.png)

以建立為例：/api/business/{name}，其中name為物件名稱複數形式（相容物件名稱）

### 業務資料

#### 通過post man驗證API

##### 建立學生
![postman](https://help.crudapi.cn/img/metadata/helloworld/postman.png)

請求URL  
https://demo.crudapi.cn/api/business/students

請求body
```bash
{
    "name":"諸葛亮",
    "stuNo":"10000",
    "age":18,
    "major":"電腦科學與技術"
}
```
返回值1為id

##### 查詢id為1的學生詳情
![getstudent](https://help.crudapi.cn/img/metadata/helloworld/getstudent.png)

請求URL  
https://demo.crudapi.cn/api/business/students/1

返回body
```bash
{
    "id": 1,
    "name": "諸葛亮",
    "createdDate": 1613013249000,
    "stuNo": "10000",
    "age": 18,
    "major": "電腦科學與技術"
}
```

#### 通過UI操作
##### 建立學生
![uicreate](https://help.crudapi.cn/img/metadata/helloworld/uicreate.png)

##### 獲取所有學生列表
![uilist](https://help.crudapi.cn/img/metadata/helloworld/uilist.png)

#### 其它操作
還有編輯，刪除等API類似，檢視swager文件即可！

### 小結
本文通過配置表單的方式實現了RESTful CRUD API，和傳統開發的方式對比如下：

實現方式 | 程式碼量 | 時間 | 穩定性
--- | --- | --- | --- 
傳統開發 | 1000行左右 | 2天/人 | 5個bug左右
crudapi系統 | 0行 | 1分鐘  | 基本為0

綜上所述，利用crudapi系統可以極大的提高工作效率和節約成本，讓資料處理變得更簡單！
本系統屬於產品級的零程式碼平臺，不需要生成Controller、Service、Repository、Entity等業務程式碼，程式執行起來就可以使用，真正0程式碼，可以覆蓋基本的和業務無關的CRUD RESTful API。

無需程式設計，通過配置零程式碼生成CRUD RESTful API

相關文章