MCP Fastapi Learning

🚀 FastAPI 你好，世界！應用程序

這是一個簡單的 Hello World API，藉助 FastAPI 和 MCP SSE 支持構建而成，能實現基本問候功能，還集成了 OpenAI 的 GPT - 4o 模型，並且可自動生成 API 文檔。

✨ 主要特性

• 根路由：返回一條 Hello World 消息。
• 帶有名字參數的動態問候接口，可實現個性化問候。
• 集成 OpenAI 的 GPT - 4o 模型以實現高級 AI 聊天完成功能。
• 自動生成 API 文檔並提供 Swagger UI，方便查看和測試接口。

📦 安裝指南

你可以選擇在本地或使用 Docker 運行此應用程序。

本地安裝

1. 克隆倉庫

git clone https://github.com/xxradar/mcp-test-repo.git
cd mcp-test-repo

2. 創建虛擬環境（可選但推薦）

# 在 macOS/Linux 系統上
python -m venv venv
source venv/bin/activate

# 在 Windows 系統上
python -m venv venv
venv\Scripts\activate

3. 安裝依賴項

pip install -r requirements.txt

4. 運行應用程序

uvicorn main:app --reload

應用程序啟動後將在 http://127.0.0.1:8000 上可用。

或者，你可以直接使用 Python 運行：

python main.py

Docker 安裝

1. 克隆倉庫

git clone https://github.com/xxradar/mcp-test-repo.git
cd mcp-test-repo

2. 構建 Docker 鏡像

docker build -t fastapi-hello-world .

3. 運行 Docker 容器

docker run -p 8000:8000 fastapi-hello-world

應用程序將在 http://localhost:8000 上可用。

📚 詳細文檔

API 接口

• GET /：返回一條簡單的 Hello World 消息。
• GET /hello/{name}：根據提供的名字返回個性化的問候消息。
• GET /openai：使用 OpenAI 的 GPT - 4o 模型進行響應（接受一個可選的 prompt 查詢參數）。
• GET /docs：Swagger UI 文檔界面。
• GET /redoc：ReDoc 文檔界面。

OpenAI 集成

/openai 接口使用 OpenAI 的 GPT - 4o 模型，並需要在環境中設置 OpenAI API 密鑰。

本地安裝

# 設置 OpenAI API 密鑰為環境變量
export OPENAI_API_KEY=your_api_key_here

# 運行應用程序
uvicorn main:app --reload

Docker 安裝

# 使用 OpenAI API 密鑰運行 Docker 容器
docker run -p 8000:8000 -e OPENAI_API_KEY=your_api_key_here fastapi-hello-world

💻 使用示例

使用 curl

# 獲取 Hello World 消息
curl http://127.0.0.1:8000/

# 獲取個性化的問候消息
curl http://127.0.0.1:8000/hello/World

# 訪問 Swagger UI 文檔界面
curl http://127.0.0.1:8000/docs

# 使用 OpenAI 接口進行示例請求
curl -X POST "http://127.0.0.1:8000/openai/?prompt=你好%2C+我是新手。你能教我什麼？"

使用 Swagger UI

1. 打開瀏覽器，訪問 http://127.0.0.1:8000/docs。
2. 在文檔界面中，找到 /openai 接口。
3. 點擊該接口的“Try It Out”按鈕。
4. 在 prompt 參數處輸入你的問題或提示，例如 “你好，我是新手。你能教我什麼？”
5. 點擊“Execute”按鈕，查看 OpenAI 的響應。

⚠️ 重要提示

• 安裝時請確保 Python 版本為 3.7 或更高。
• 使用 Docker 時，請根據需要調整端口映射或其他配置。
• 在生產環境中使用前，請確保已正確設置 OpenAI API 密鑰，並瞭解其費用和使用限制。