Giao diện chính của Apidog được chia thành các khu vực chính sau:
Bố cục này bảo đảm việc điều hướng hiệu quả cho phát triển và kiểm thử API.
Header cung cấp quyền truy cập nhanh vào các chức năng thiết yếu.
| Tính năng | Mô tả |
|---|---|
| Home | Truy cập trang chủ cá nhân của bạn với các nhóm, dự án và API hub. |
| Project Tabs | Chuyển đổi giữa các dự án. Nhấp vào nút bên cạnh tên để mở trong một cửa sổ mới. |
| Upgrade/Plan | Xem gói hiện tại của nhóm bạn. |
| Refresh | Tải lại dữ liệu dự án. Lưu ý: Thao tác này sẽ đóng tất cả các tab đang mở. |
| Settings | Cấu hình các cài đặt cục bộ như giao diện và proxy. |
| Notifications | Kiểm tra cảnh báo hoạt động của nhóm. |
| Avatar | Quản lý cài đặt tài khoản và access token. |
TIP
Để chuyển đổi dự án, hãy nhấp vào bất kỳ tab dự án nào trong header.
Sidebar tổ chức các tính năng cốt lõi của Apidog.
| Tính năng | Mô tả |
|---|---|
| Project Icon | Chuyển đến phần tổng quan nhóm và dự án. |
| APIs | Định nghĩa, debug, gửi yêu cầu, tạo schemas và viết tài liệu. |
| Tests | Chạy yêu cầu hàng loạt, tạo kịch bản, xem báo cáo và quản lý CI/CD. |
| Share Docs | Chia sẻ và xuất bản tài liệu API với các tùy chọn tùy chỉnh. |
| History | Xem và gửi lại các yêu cầu đã gửi. |
| Settings | Quản lý cài đặt dự án, thông báo và dữ liệu. |
| Invite | Mời người dùng vào dự án. |
TIP
Sử dụng Sidebar để nhanh chóng truy cập các tính năng thường dùng như APIs và Tests.
Workbench là không gian làm việc trung tâm để quản lý các thành phần của dự án.
Cây thư mục tổ chức các thành phần dự án theo hệ thống phân cấp.
| Tính năng | Mô tả |
|---|---|
| Branches and Versions | Chuyển đổi nhánh hoặc quản lý phiên bản. Mặc định là nhánh main. |
| Search and Filter | Tìm kiếm endpoint (không tìm kiếm thư mục hoặc case). |
| Create New | Thêm endpoint, yêu cầu, schemas, v.v. |
| <Tên dự án> | Chế độ xem dự án cấp cao. |
| Endpoints | Tổ chức endpoint và case trong các thư mục. |
| Schemas | Quản lý schemas trong các thư mục. |
| Components | Các thành phần phản hồi có thể tái sử dụng. |
| Admin API | Chứa các công cụ để quản trị viên xử lý dữ liệu hàng loạt. |
| Quick Requests | Tổ chức các yêu cầu nhanh được tạo trong dự án này. |
TIP
Để tạo endpoint mới, hãy nhấp vào biểu tượng Create New trong cây thư mục.
Nhấp vào một thành phần sẽ mở một tab. Các tab hỗ trợ những loại như Endpoint, Schema, Request và Markdown.
Các nút ở bên phải:
TIP
Sử dụng thao tác nhấp đúp để giữ tab cố định trong quá trình chỉnh sửa nhiều thành phần.
Chọn môi trường để kiểm thử API. Chuyển đổi giữa dev, staging hoặc production để bảo đảm các yêu cầu sử dụng đúng cài đặt.
Ví dụ: Nhấp vào menu thả xuống môi trường trong workbench để thay đổi ngữ cảnh.
Footer cung cấp trạng thái và các công cụ tiện ích.
| Tính năng | Mô tả |
|---|---|
| Collapse/Expand | Bật/tắt khả năng hiển thị của cây thư mục. |
| Online | Hiển thị trạng thái kết nối. Trạng thái ngoại tuyến ảnh hưởng đến đồng bộ hóa. |
| Agent | Chọn agent cho yêu cầu (chỉ Apidog Web). |
| Cookies | Quản lý cookies. |
| Trash | Xem các mục đã xóa (tự động xóa sau 30 ngày). |
| Community | Tham gia cộng đồng Apidog trên Discord, Slack, X, hoặc Email. |
TIP
Kiểm tra trạng thái Online để bảo đảm đồng bộ hóa nhóm.