API Academy
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Developing APIs
  • 歡迎
  • 目錄
  • API 學院
    • Get Started
      • 什麼是 API?
      • API 如何運作?
      • 如何呼叫 API?
      • 如何閱讀 API 文件?
      • 章節總結
    • API Fundamentals
      • API 基礎知識:概覽
      • 方法與路徑
      • 參數
      • 請求 Body
      • 回應
      • API 規格與 OAS
      • 章節總結
    • Working with APIs
      • 使用 API:概覽
      • 根據規格發送請求
      • 環境與變數
      • 串聯多個端點
      • 處理 Auth
      • 處理 API 簽名
      • 腳本介紹
      • 章節總結
    • Mocking APIs
      • Mocking API:概覽
      • Smart Mock
      • Mock 預期結果
      • Cloud Mock
      • Mock 腳本
      • 章節總結
    • Designing APIs
      • 設計 API:概覽
      • API 設計介紹
      • 建立您的第一個 API 專案
      • 分析需求並規劃您的 API
      • 設計資料模型
      • 設計端點
      • 使用組件與可重用性
      • 設定與 Auth
      • API 設計指南
      • 章節總結
    • Developing APIs
      • 開發 API:概覽
      • 設定:安裝您的 AI 程式碼助手
      • 快速入門:30 分鐘內從規格到運行的 API
      • 了解生成的程式碼
      • 使用 Apidog 測試您的 API
      • 部署:將您的 API 上線
      • 章節總結
    • Testing APIs
      • 測試 API:概覽
      • 快速入門:您的第一個測試場景
      • 整合測試與資料傳遞
      • 動態值
      • 斷言與驗證
      • 流程控制:If, For, ForEach
      • 資料驅動測試
      • 性能測試
      • 測試報告與分析
      • CI/CD 整合
      • 排程任務與自動化
      • 進階測試策略
      • 章節總結
    • API Documentations
      • API 文件:概覽
      • 發布您的第一個 API 文件
      • 自訂文件外觀
      • 給消費者的互動功能
      • 進階發布設定
      • 管理 API 版本
      • 章節總結
    • Advanced API Technologies
      • 進階 API 技術:概覽
      • GraphQL
      • gRPC
      • WebSocket
      • Socket.IO
      • Server-Sent Events
      • SOAP
      • 章節總結
    • API Lifecycle
      • API 生命周期:概覽
      • API 生命周期的階段
      • API 治理
      • API 安全最佳實踐
      • 監控與分析
      • API 版本策略
      • API 的未來
      • 章節總結
    • API Security
      • API 安全性:概覽
      • API 安全性基礎知識
      • 身份驗證 vs. 授權
      • 了解 OAuth 2.0 和 OpenID Connect
      • JSON Web Tokens (JWT)
      • OWASP API 安全 Top 10
      • 加密與 HTTPS
      • 章節總結
    • API Tools
      • API 工具:概覽
      • API 工具的演變
      • API Clients
      • 命令列工具 (cURL, HTTPie)
      • API 設計和文件工具
      • API Mocking 工具
      • API 測試工具
      • 一體化 API 平台
      • 章節總結
    • API Gateway
      • API Gateway:概覽
      • 什麼是 API Gateway?
      • API Gateway 的關鍵功能
      • API Gateway vs 負載平衡器 vs 服務網格
      • 流行 API Gateway 解決方案
      • BFF (Backend for Frontend) 模式
      • 章節總結
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Developing APIs

開發 API:概覽

您已經在 Apidog 中設計了一個完整的使用者 API。現在是時候將該設計轉化為可運作的程式碼了。
這可能會讓您感到驚訝:您實際上不再需要從頭開始編寫所有內容。有了現今的 AI 工具,您可以在大約 30 分鐘內從您的設計規格生成一個完整的、生產就緒的 API。我知道這聽起來好得令人難以置信,但請繼續看下去。

開發方式的改變#

試想一下以前人們是如何建立 API 的。您需要花費數週時間學習程式語言,然後再花數週學習框架,最後才開始編寫程式碼。經過數小時的除錯後,您可能會得到一個勉強可用的東西。也許吧。如果您夠幸運的話。
現在的情況已不再如此。在 2024 年,您只需匯出您的 API 規格,將其提供給 AI 編碼助手,然後就能獲得一個包含身分驗證、資料庫整合、錯誤處理以及您所需一切的完整專案。然後,您將時間花在理解和自訂它上,而不是與語法錯誤搏鬥。
區別在於: 以前需要幾週的時間,現在只需幾小時。

我們要建立什麼#

在本章中,您將建立一個完整的使用者 API,其中包含這些端點:
POST /users - 使用者註冊
POST /user/login - 使用 JWT token 登入
GET /users/{id} - 獲取使用者個人資料
PUT /users/{id} - 更新使用者(需驗證)
DELETE /users/{id} - 刪除帳戶(需驗證)
POST /user/logout - 登出(需驗證)
它將包含資料庫儲存(開發環境使用 SQLite,生產環境使用 PostgreSQL)、JWT 身分驗證、密碼雜湊、輸入驗證、適當的錯誤處理和安全性最佳實踐。
最終結果是一個您實際上可以部署到線上並向人們展示的東西。這是一個真正的 API,而不是一個玩具專案。

工作流程#

這個過程出奇地簡單。以下是您將要執行的操作:
1. 匯出您的 API 設計
在 Apidog 中,前往 Settings → Export → OpenAPI 3.0。您將獲得一個包含完整 API 設計的 openapi.json 檔案。
2. 使用 AI 生成程式碼
在 Cursor 或 Windsurf 中打開該檔案,並要求它生成一個完整的專案。在大約 10 分鐘內,您將擁有完整的專案結構、所有實作的端點、配置好的資料庫以及可運作的身分驗證。
3. 在本地執行
您的 API 將在 http://localhost:8000 上執行。
4. 在 Apidog 中測試
切換到您的「本地」環境,測試所有端點,並驗證回應是否符合您的設計。
5. 部署
您的 API 現在已上線並擁有公開 URL。
當我說它很快時,我是認真的。從匯出到部署 API 在一小時內完成是完全現實的。

您將使用的工具#

AI 編碼助手(選擇其一):
Cursor - cursor.sh(推薦)
最佳的 AI 編碼體驗,具有適用於完整專案的 "Composer" 模式
提供免費試用,之後每月 20 美元
大多數專業開發者使用的工具
Windsurf - codeium.com/windsurf(免費)
完全免費,具有類似的 "Cascade" 模式
如果您想在不付費的情況下開始,這是一個很好的替代方案
這些不僅僅是美化的自動完成工具。它們了解您的 API 規格,生成整個專案,解釋程式碼的作用,幫助除錯問題,並建議改進。這就像有一位經驗豐富的開發者與您結對程式設計。
Python 3.10+
執行您的 API。安裝一次,使用簡單的指令。我們將在設定章節中介紹安裝。
Apidog
您已經擁有它了!用於測試和驗證。
Railway 或 Render
提供 API 公開 URL 的免費部署平台。

準備好了嗎?#

確保您已完成「設計 API」章節,並在 Apidog 中設計好了您的 User 模組。這實際上就是您所需要的全部內容。
接下來是安裝 Cursor 或 Windsurf 以及 Python,這大約需要 15 分鐘。然後,您將在 30 分鐘內生成您的第一個完整 API。
繼續閱讀 → 設定:安裝您的 AI 編碼助手
Modified at 2025-12-29 09:35:19
Previous
章節總結
Next
設定:安裝您的 AI 程式碼助手
Built with