Initial commit
This commit is contained in:
75
README.md
Normal file
75
README.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# Flask MySQL API
|
||||
|
||||
這是一個使用 Flask 和 MySQL 建立的 RESTful API 服務,提供使用者資料的 CRUD 操作。
|
||||
|
||||
## 功能特點
|
||||
|
||||
- 完整的 RESTful API 設計
|
||||
- MySQL 資料庫連接
|
||||
- 參數化查詢防止 SQL 注入
|
||||
- 支援分頁和過濾
|
||||
- 統一的回應格式
|
||||
- 錯誤處理
|
||||
- CORS 支援
|
||||
|
||||
## API 端點
|
||||
|
||||
- `GET /v1/users`:取得所有使用者,支援 `min_age`、`max_age`、`page`、`limit` 參數
|
||||
- `GET /v1/users/<id>`:取得特定使用者
|
||||
- `POST /v1/users`:建立新使用者
|
||||
- `PATCH /v1/users/<id>`:更新使用者資料
|
||||
- `DELETE /v1/users/<id>`:刪除使用者
|
||||
|
||||
## 安裝與執行
|
||||
|
||||
1. 安裝必要套件:
|
||||
|
||||
```bash
|
||||
pip install Flask mysql-connector-python flask-cors
|
||||
```
|
||||
|
||||
2. 執行應用程式:
|
||||
|
||||
```bash
|
||||
python app.py
|
||||
```
|
||||
|
||||
伺服器將在 http://localhost:5000 啟動。
|
||||
|
||||
## 使用範例
|
||||
|
||||
### 取得所有使用者(含分頁和過濾)
|
||||
|
||||
```
|
||||
GET /v1/users?min_age=18&max_age=30&page=1&limit=10
|
||||
```
|
||||
|
||||
### 建立新使用者
|
||||
|
||||
```
|
||||
POST /v1/users
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "王小明",
|
||||
"email": "wang@example.com",
|
||||
"age": 25
|
||||
}
|
||||
```
|
||||
|
||||
### 更新使用者
|
||||
|
||||
```
|
||||
PATCH /v1/users/1
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"age": 26
|
||||
}
|
||||
```
|
||||
|
||||
### 刪除使用者
|
||||
|
||||
```
|
||||
DELETE /v1/users/1
|
||||
```
|
Reference in New Issue
Block a user