API Academy
🌐 繁體中文
🌐 English
🌐 繁體中文
Home
Petstore API
Explore more APIs
Home
Petstore API
Explore more APIs
🌐 繁體中文
🌐 English
🌐 繁體中文
🌐 繁體中文
🌐 English
🌐 繁體中文
API Documentations
Copy Page
歡迎
目錄
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) 模式
章節總結
Home
Petstore API
Explore more APIs
Home
Petstore API
Explore more APIs
🌐 繁體中文
🌐 English
🌐 繁體中文
🌐 繁體中文
🌐 English
🌐 繁體中文
API Documentations
Copy Page
章節總結
恭喜!您已成功完成了標準化的 API 文件流程。
在本章中,我們強調了
文件即產品
。它是其他開發者體驗您工作的主要介面。透過使用 Apidog,您已將手動瑣事轉變為自動化、設計驅動的工作流程。
您已完成的事項
#
您現在具備以下技能:
即時發布
:一鍵將您的 API 設計轉換為託管的文件網站。
品牌化您的入口網站
:自訂外觀和感覺(Logo、顏色、網域),使文件完全屬於您自己。
賦能消費者
:提供互動式「Try it out」控制台和程式碼生成工具,加速整合。
控制存取
:透過密碼保護、企業 SSO 和版本策略管理誰可以看到什麼。
關鍵理念:「Doc-as-Code」
#
本章最大的收穫是
Doc-as-Code
方法的效率。
與其分開編寫文件(這很容易過時),您的文件直接從您的 API 定義生成。
當程式碼變更時,文件也會變更。
這確保您的消費者始終擁有最新資訊。
下一步是什麼?
#
您現在已經掌握了 API 生命週期的核心支柱: