Tạo một dự án API mới

Trong Apidog, mỗi dự án tương ứng với một tệp API Specification hoặc OpenAPI Specification (OAS). Bạn có thể tạo một dự án API mới hoặc nhập một dự án hiện có từ mục Home > My Teams > Projects trong ứng dụng Apidog.

Tạo dự án

Trong cửa sổ chính, nhấp vào nút + New Project ở góc trên bên phải.

Chọn danh mục dự án ở phía trên: General hoặc gRPC.

General: Chọn tùy chọn này cho hầu hết các API. Tùy chọn này hỗ trợ HTTP(s), WebSocket, Socket.IO, Webhook, Markdown, v.v.

gRPC: Chọn tùy chọn này cho các API sử dụng giao thức gRPC. Tìm hiểu thêm về dự án gRPC.

(Nếu bạn đã chọn General) Chọn chế độ dự án mong muốn. Apidog cung cấp hai quy trình làm việc riêng biệt: General Mode và Spec-first Mode. Thực hiện theo hướng dẫn bên dưới dựa trên lựa chọn của bạn.

General Mode

Phù hợp nhất cho các quy trình làm việc dựa trên GUI. Chế độ này bao gồm Visual API Editor để thiết kế, gỡ lỗi, kiểm thử API và tạo tài liệu tự động. Bạn cũng có thể sao lưu OpenAPI Specs được tạo tự động vào một kho lưu trữ Git.

Chọn General Mode.

Nhập tên cho dự án của bạn.

(Tùy chọn) Đánh dấu tùy chọn Including Examples để tạo một dự án có dữ liệu mẫu từ ví dụ PetStore.

(Dành cho các nhóm có nhiều người dùng) Thiết lập quyền cho các thành viên khác trong nhóm trong quá trình tạo dự án. Để biết thêm thông tin, xem Cài đặt quyền thành viên.

(Tùy chọn) Thiết lập Project language. Để biết thêm thông tin, xem Cài đặt ngôn ngữ.

Spec-first Mode (Beta)

Lý tưởng cho quy trình làm việc Git gốc. Thiết kế API specs bằng OpenAPI Spec Editor (tệp YAML/JSON) và duy trì đồng bộ hai chiều liền mạch với kho lưu trữ Git của bạn.

Chọn Spec-first Mode.

Cuộn xuống mục Connect with Git Repository.

Nhấp vào Connect to GitHub hoặc Connect to GitLab SaaS để liên kết kho lưu trữ của bạn và cấu hình cài đặt đồng bộ.

(Dành cho các nhóm có nhiều người dùng) Thiết lập quyền cho các thành viên khác trong nhóm. Để biết thêm thông tin, xem Cài đặt quyền thành viên.

Tìm hiểu thêm

Để tìm hiểu chuyên sâu về không gian làm việc Specs dựa trên mã, phân tích thư mục theo thời gian thực và quy trình commit Git, hãy xem hướng dẫn chi tiết của chúng tôi về Spec-first Mode.

Nhập API hiện có

Nếu bạn đã có API Specification, bạn có thể bắt đầu quy trình nhập từ mục Team > Projects bằng cách chọn Import Project, hoặc trực tiếp trong một dự án hiện có bằng cách nhấp vào dấu ➕ lớn và chọn Import. Đây là lựa chọn lý tưởng để di chuyển dữ liệu API hiện có vào Apidog.

Nhấp vào "Import Project".

Chọn loại dữ liệu bạn muốn nhập.

Tải tệp lên hoặc dán URL dữ liệu (chỉ các định dạng OpenAPI/Swagger).

Apidog sẽ tự động nhận diện và phân tích nội dung dựa trên định dạng đã chọn. Bạn sẽ có thể xem trước dữ liệu trước khi nhập. Chọn nội dung bạn muốn nhập và cấu hình logic nhập. Sau đó xác nhận để tạo và nhập dự án.

Sau khi quá trình nhập hoàn tất, dự án mới của bạn sẽ sẵn sàng để sử dụng.

Tìm hiểu thêm

Để biết thông tin chi tiết về quy trình nhập, xem Hướng dẫn nhập.

Tạo một dự án API mới

Tạo dự án#

General Mode#

Spec-first Mode (Beta)#

Nhập API hiện có#

Tạo dự án

General Mode

Spec-first Mode (Beta)

Nhập API hiện có