既然您已經了解 API 設計的基礎知識，現在是時候設定您的工作區了。Apidog 中的 API 專案是一個容器，用於組織您所有的 API 設計工作，包括多個 API 模組、測試和文件。在您開始設計端點或建立 schema 之前，您需要一個專案來工作。在本章中，我們將學習如何建立一個新的 API 專案，了解其結構，並組織您的 API 模組。我們將使用 Pet Store User 模組作為範例。
1. 什麼是 API 專案？#
Apidog 中的 API 專案是一個工作區，包含三個主要部分：API (APIs)#
每個 模組 對應一個 OpenAPI 規格 (OAS) 檔案
端點 (Endpoints) — 您的 API 端點 (GET, POST, PUT, DELETE 等)
元件 (Components) — 可重複使用的元件（參數、請求體、回應）
測試 (Tests)#
文件 (Documentation)#
關鍵概念： 一個專案可以包含多個模組。每個模組是一個獨立的 OAS 檔案，允許您在同一個專案中組織不同的 API 或 API 版本。
2. 建立新 API 專案#
讓我們為 Pet Store User 模組建立一個新的 API 專案。步驟 1：開始建立#
1.
在 Apidog 主視窗中，點擊右上角的 「+ New Project」 按鈕
2.
選擇專案類型：HTTP（適用於像我們的 User API 這樣的 REST API）
gRPC 專案，但對於 REST API，請選擇 HTTP。步驟 2：配置基本資訊#
1.
輸入專案名稱： "Pet Store API"（如果您喜歡，也可以是 "Pet Store User API"）
2.
新增描述（可選）： "用於管理 Pet Store 系統中使用者帳戶的 API"
3.
包含範例（可選）： 您可以勾選此項以從範例資料開始，但對於我們的教學，我們將從頭開始
步驟 3：完成建立#
點擊 「Create」 以建立您的專案。Apidog 將打開新專案，您將看到一個空的專案結構。
3. 了解模組#
當您建立專案時，Apidog 會在 APIs 部分自動建立一個預設模組。模組是一個對應於一個 OpenAPI 規格 (OAS) 檔案的容器。每個模組都包含端點、schemas 和元件。在模組內組織#
在模組內，您可以使用資料夾來組織端點和 schemas：APIs/
└── Pet Store API Module/
├── Endpoints/
│ └── User/
│ ├── User Management/
│ └── Authentication/
└── Schemas/
├── User
└── UserPreferences
Endpoints/User/ — 包含所有與 User 相關的端點User Management/ — CRUD 操作（建立、獲取、更新、刪除）
Authentication/ — 登入和登出端點
Schemas/ — 您所有的 schemas (User, UserPreferences 等)
多個模組#
不同的服務 (User API, Order API, Payment API)
不同的環境 (Development, Production)
4. 匯入現有 API（可選）#
如果您已經有 OpenAPI/Swagger 規格檔案，您可以匯入它：1.
點擊 "Import Project"（或 ➕ 圖示 → Import）
5. 關鍵收穫#
1.
API 專案包含三個主要部分：APIs、Tests 和 Documentation
2.
APIs 部分包含模組，每個模組對應一個 OAS 檔案
4.
從主視窗使 用「+ New Project」建立專案
6.
多個模組允許您在一個專案中管理不同的 API 或版本
現在您的專案已設定好，準備好開始設計流程了。在下一章中，我們將學習如何分析需求並規劃您的 API——這是確保您的 API 滿足實際需求的關鍵步驟。 Modified at 2025-12-29 09:35:19
