目標

今天的目標很明顯了

會介紹Fast API
其中會想跟大家探討

其實網頁後端框架千百種光是程式語言(C#、PHP、Nodejs、Go...)
就有很多對手在跟python打架了

為什麼會想選Python的Fast API

今天會學到

1.評估框架的選擇
2.Fast API 起手式

1.評估框架的選擇

1.1 團隊&個人開發者必須評估

在決定使用哪個後端框架時，應綜合考慮專案需求、技術支援、團隊背景、效能及生態系統等因素。這樣可以確保所選技術不僅能滿足當前需求，還能為未來的增長和變化提供足夠的支持。

1. 專案需求

功能需求：明確了解專案的功能需求，例如是否需要即時通訊、數據處理或是高並發支持。這將幫助您選擇最適合的框架。
數據類型：考慮將要處理的數據類型，某些框架在處理特定數據（如結構化或非結構化數據）上表現更佳。

2. 技術支援

社群與文檔：選擇一個有活躍社群和良好文檔支持的框架，可以獲得更多資源和幫助。例如，Django 和 Flask 在 Python 生態系統中擁有強大的社群支持。
更新頻率：框架的持續更新和維護情況，能影響到安全性和新功能的引入。

3. 團隊背景

開發者經驗：團隊對特定語言或框架的熟悉程度會影響開發效率。如果團隊已經熟悉某種語言，選擇相關的框架將更為高效。
培訓需求：如果團隊需要學習新技術，這可能會增加初期開發的時間和成本。

4. 效能

性能測試：不同框架在性能上的表現可能有所不同。例如，Node.js 因其非阻塞 I/O 模型而在高並發情況下表現優異，而 Django 雖然功能強大，但在某些情況下可能速度較慢。
擴展性：考慮未來的擴展需求，某些框架如 Flask 提供了極大的靈活性，適合構建微服務架構。

5. 生態系統

第三方庫和工具：評估框架周圍的生態系統，包括可用的第三方庫、工具和插件。這可以加快開發過程並提高功能實現的便利性。

綜合評比我們可以得到

1.2 個人開發者必須評估

前面是以1.1團隊為主，雖說只要公司or老闆一句話我們就是用XXX框架就定案了
但如果是可商量的情況下還是要做完整評估喔~!

1. 市場需求

公司需求：選擇市場上熱門、企業常用的技術或框架，可以增加求職的機會。查看各大招聘網站或技術趨勢報告（如Stack Overflow、GitHub的年報）可以幫助了解目前哪些框架最受歡迎。
實際應用：根據想進入的行業（如Web開發、數據分析、AI/ML等），選擇該領域常見的框架。例如，如果你希望進入Web開發領域，學習FastAPI、Flask、Django這類Python框架是很有幫助的。

2. 薪水高低

薪資水平：研究各種技術的市場價值。通常，較新且技術需求高的框架，其開發人員薪水也會較高。根據各地區的薪資報告、招聘網站的數據，查詢特定框架的開發人員薪資範圍，可以幫助你選擇學習那些薪酬高的技術。

3. 社群支持

社群活躍度：選擇有活躍社群支持的框架可以幫助你快速學習和解決問題。框架的GitHub issues數量、Stack Overflow問答數量、官方文檔的完整度等都能反映其社群的活躍程度和技術支持的好壞。
資源多寡：是否有豐富的學習資源，如教程、書籍、線上課程、官方範例等，這將直接影響學習效率。像是FastAPI、Flask、Django等都有大量資源，適合自學者。
其他考量因素：

4. 學習曲線

一些框架簡單易上手（如Flask），適合初學者。而像Django這樣的框架功能強大，但學習曲線稍陡，需要更多時間學習。

5.未來發展前景

選擇有長期發展潛力的框架可以保障你未來的技術投資不會過時。例如，FastAPI因為其異步支持和高性能逐漸被更多公司採用，有良好的發展潛力。

1.3 Roni的建議框架!?

以上兩點都是客觀評論
接下來是我Roni主觀的選擇了~

我會根據上述兩點綜合評估選擇下面四種來學習
根據不同情境來使用不同語言的框架來接案或是滿足老闆需求

其實這些語言能達到的都可以互通比如說
Nodejs(爬蟲) <=> Python(爬蟲)
Go(web microservice) <=> Nodejs
...但我想要把那個情境下綜合評估最強CP值最高的框架拿來用XDD

以下評論為投資理財分析，不構成投資建議!?

我會簡單分成

1. 開發高效能API微服務: Nestjs
2. 資料科學: Fast API 跟其他套件
3. 企業開發: spring boot or C#

微服務不選Go的原因是因為沒有class(作者不太喜歡繼承這個OOP特性)跟套件相對python還是少。
強調並不是Go不好，但是就跟工程師有擅長的位置，語言也有擅長的處理情境。

Python也有許多框架，選擇Fast API對某些團隊來說也不一定是最好的
但是對我來說，我需要一個專門處理資料科學、AI界接的微服務是必選一個python backend framework
那麼不希望Django學太多技術債(寧願把時間花在spring或是C#框架上)
Flask相較Fast API 也不夠快速
所以Fast 也變成首選

**軟體開發心聲 - PHP的開發者 **

就像前面說的有些人會說
沒有Golang的爆發、JAVA的生態、JS的異步處理
給人家感覺PHP就像運動選手中，跑步不快(go)、身體不夠強壯(java)、反應不夠(js)
Laravel (PHP) 並沒有不好 : 他也有適合的天地，Sass 、MVP(Minimum Viable Product)系統。
他也可以像是跳水員，優雅而且特定的展示屬於自己的舞台。

2.Fast API 起手式

這張章節會簡介什麼是REST API 以及會使用到的必要知識。

先麻煩個未安裝相關套件吧~!!

pip install fastapi uvicorn pydantic

2.1 REST API介紹

這個觀念我很推薦看這位大師的說明
https://www.linkedin.com/pulse/principles-best-practices-rest-api-design-omar-ismail/

這邊會精簡成只使用到必要的需求來創造API

2.2 Fast API Create & Get

今天的目標很簡單
需求: 建立兩隻API(POST 跟GET )

POST API的需求是

• 讀取customer.json檔案資料
• 從前端接受資料
• 檢查是否Json file 有相同ID ，若有要回傳重複ID
• 沒有重複會新增到JSON file裡面

main.py

import json
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

app = FastAPI()

# 顧客資料模型
class Customer(BaseModel):
    id: int
    name: str
    email: str
    address: str = None  

# 讀取顧客資料
def read_customers():
    try:
        with open('customer.json', 'r', encoding='utf-8') as file:
            return json.load(file)
    except FileNotFoundError:
        return []

# 寫入顧客資料
def write_customers(customers):
    with open('customer.json', 'w', encoding='utf-8') as file:
        json.dump([customer for customer in customers], file, ensure_ascii=False, indent=4)

# 新增顧客
@app.post("/customers/", response_model=Customer)
async def create_customer(customer: Customer):
    customers = read_customers()

    # 檢查顧客ID是否已存在
    if any(c['id'] == customer.id for c in customers):
        raise HTTPException(status_code=400, detail="Customer ID already exists.")

    customers.append(customer.dict())  # 將 Pydantic 模型轉換為字典並添加到顧客列表
    write_customers(customers)
    return customer

# 獲取所有顧客
@app.get("/customers/", response_model=list)
async def get_customers():
    return read_customers()

執行程式碼 檔案名稱要叫做main.py

uvicorn main:app --reload

執行步驟

1. 在command line執行指令
2. 可以從postman來call API : 輸入http://127.0.0.1:8000/customers/ Post
   範例json

{
    "id": 1,
    "name": "王小明",
    "email": "xiaoming@example.com",
    "address": "台北市信義區"
}

如果成功，就代表已經學會最基本的post api了~

接下來我們來逐步講解程式碼吧~

pydantic( BaseModel ) 型別處理模組

1. 數據定義
   BaseModel 允許開發者通過類定義數據結構，並使用 Python 類型註解來指定每個屬性的類型

from pydantic import BaseModel

class Customer(BaseModel):
    id: int
    name: str
    email: str
    address: str = None  

2. 自動數據驗證

當創建 BaseModel 的實例時，Pydantic 會自動檢查傳入數據的類型，並在不符合時引發錯誤。這樣可以確保數據的一致性和正確性。

3.數據轉換

Pydantic 能夠自動將輸入數據轉換為指定的類型。例如，字符串 "123" 會被轉換為整數 123

Fast API( @Post )

1. @app.post("/customers/", response_model=Customer)
   這行使用了 FastAPI 提供的 路由裝飾器。

• @app.post 表示這個 API 端點將處理 HTTP POST 請求。
• "/customers/" 是路由，表示這個端點的 URL 路徑
• 當使用者對該路徑發送 POST 請求時，會觸發這個函數。

response_model=Customer 表示這個 API 端點將會以 Customer 模型作為回應格式。這意味著，當成功新增顧客後，會以 Customer 的結構回應給客戶端。

2. async def create_customer(customer: Customer):

• 異步函數 create_customer，接收一個 Customer 物件作為輸入參數。
• Customer 是基於 Pydantic 的資料模型
• 這意味著 FastAPI 會自動驗證傳入的資料是否符合 Customer 的格式和類型要求。

3. customers = read_customers()
   這行調用了 read_customers() 函數，該函數會從 customer.json 檔案中讀取現有的顧客資料，並以列表形式返回。這些資料稍後會被用來檢查是否已經存在相同的顧客 ID。

4. if any(c['id'] == customer.id for c in customers):
   這行使用 any() 函數來檢查是否有任何現有顧客的 id 與新的 customer.id 相同。

• any() 函數會遍歷 customers 列表中的每個字典物件 (c)
• 檢查它們的 id 是否與新的 customer.id 相同。
• 如果有一個相同，any() 函數會返回 True，表示該顧客ID已經存在。

5. raise HTTPException(status_code=400, detail="Customer ID already exists.")
   如果前面的 any() 條件成立（即顧客 ID 已存在），這行會拋出一個 HTTP 400 錯誤，告知客戶端這個顧客 ID 已存在。

HTTPException 是 FastAPI 用來拋出 HTTP 錯誤的方式，
其中 status_code=400 表示「錯誤的請求」（Bad Request），而 detail 中的訊息會傳回給客戶端。
6. customers.append(customer.dict())
這行將新的顧客資料添加到 customers 列表中。

customer.dict() 是一個 Pydantic 模型的方法，用來將 Pydantic 模型轉換為字典格式。這樣做是因為顧客列表中的每個顧客資料都是字典格式的，為了保持一致性，我們需要將新的顧客資料也轉換為字典。
7. write_customers(customers)
這行呼叫了 write_customers() 函數，將更新後的顧客列表寫入 customer.json 檔案中。這會覆寫原來的資料並將新的顧客資料保存在 JSON 檔案裡。

8. return customer
   這行將新增的顧客資料（Customer 物件）回應給客戶端。由於 response_model=Customer，這個回應會遵循 Customer 模型的結構，並自動序列化為 JSON 格式傳回給客戶端。

Fast API( @Get )

程式碼部分

@app.get("/customers/", response_model=list)
async def get_customers():
    return read_customers()

操作部分
路由不變，只要改過http method變成GET即可~!!

Fast API( @Put )

實作程式碼

步驟
我們可以透過傳入id參數(比如說前面範例我把id2同樣新增一樣是王小明)
我想要把它改成John

@app.put("/customers/{customer_id}", response_model=Customer)
async def update_customer(customer_id: int, updated_customer: Customer):
    customers = read_customers()

    for i, customer in enumerate(customers):
        if customer['id'] == customer_id:
            customers[i] = updated_customer.dict()
            write_customers(customers)
            return updated_customer

    raise HTTPException(status_code=404, detail="Customer not found")

操作postman

程式碼解釋

1. @app.put("/customers/{customer_id}", response_model=Customer)

• PUT 方法：這是一個 FastAPI 定義的路由，使用 PUT 方法表示更新資源。
• /customers/{customer_id} 這個路徑表示我們要更新特定的顧客資料，
• customer_id 是一個動態變數，表示要更新的顧客的 ID。
• response_model=Customer：這表示當成功更新顧客資料後，API 會回傳一個 Customer 類型的物件

2. async def update_customer(customer_id: int, updated_customer: Customer):

• customer_id：從 URL 中傳入的參數，用來指定要更新哪個顧客的 ID。
• updated_customer：這是一個從請求主體（request body）中傳入的顧客資料，使用 Pydantic 模型 Customer 來驗證資料的結構與內容。

3. customers = read_customers()
   這行程式碼從 customer.json 檔案中讀取所有現有的顧客資料，並將其存儲在 customers 這個變數中
4. for i, customer in enumerate(customers):
   使用 enumerate() 函數來遍歷 customers 列表，並同時取得顧客的索引 i 以及對應的顧客資料 customer。這樣可以方便在找到匹配的顧客時進行資料更新。
5. if customer['id'] == customer_id:
   在迴圈中，這行程式碼檢查是否找到與 customer_id 相同的顧客。如果找到，代表要更新的顧客已存在。
6. customers[i] = updated_customer.dict()
   當找到指定的顧客時，將 updated_customer 的資料更新到 customers 列表中。這裡使用了 Pydantic 提供的 .dict() 方法，將 Customer 類型的物件轉換為字典格式，這樣資料可以直接存入 customers 列表。
   7.** write_customers(customers)**
   這行程式碼將更新後的 customers 列表寫回到 customer.json 檔案中，保存更改。
7. return updated_customer
   成功更新後，API 會回傳更新後的顧客資料，這樣客戶端可以看到更新結果。
8. raise HTTPException(status_code=404, detail="Customer not found")
   如果遍歷完所有顧客後，沒有找到符合 customer_id 的顧客，API 就會拋出一個 HTTP 404 錯誤，表示找不到該顧客。

Fast API( @DELETE )

刪除的邏輯跟更新很像所以我放在同一組=> 一樣是透過ID篩選到然後作操作
刪除只要傳路徑的ID不需要pass Data到後端處理

情境比較簡單就不畫流程圖了XDD
用patch的情境帶入即可

@app.delete("/customers/{customer_id}")
async def delete_customer(customer_id: int):
    customers = read_customers()

    # 過濾掉需要刪除的顧客
    filtered_customers = [customer for customer in customers if customer['id'] != customer_id]

    if len(filtered_customers) == len(customers):
        raise HTTPException(status_code=404, detail="Customer not found")

    write_customers(filtered_customers)
    return {"message": "Customer deleted successfully"}

程式碼解釋

列表生成式:

filtered_customers = [customer for customer in customers if customer['id'] != customer_id]

1.這行代碼創建了一個新的列表，名為 filtered_customers。
它遍歷 customers 列表中的每一個 customer。
2.條件判斷:
if customer['id'] != customer_id:
對於每個 customer，它檢查該顧客的 id 是否不等於傳入的 customer_id。
只有當條件為 True 時，該 customer 才會被包括在新的列表中。
3.過濾效果:
結果是 filtered_customers 列表只包含那些不需要被刪除的顧客。這樣可以在後續操作中用來更新顧客資料，而不包含已經刪除的顧客。

操作結果

總結

今天我們學會了
軟體評估的重要環節
HTTP Request的重要四大部分
Fast API

明天我們會使用相同的API來做界接
前端不會著墨太多

但是會帶大家看實際是怎麼橋接的~