Xuất dữ liệu

Apidog hỗ trợ xuất API sang nhiều định dạng tiêu chuẩn khác nhau, bao gồm OpenAPI Specification, HTML, Markdown, Apidog và Postman, nhằm đáp ứng các nhu cầu tích hợp và tài liệu hóa khác nhau.

Cách xuất dữ liệu

Điều hướng đến Cài đặt xuất

Đi tới Settings -> Export Data trong thanh bên trái.

CleanShot 2025-11-24 lúc 15.57.14@2x.png

Chọn phạm vi dữ liệu

Chọn xuất Tất cả API hoặc chọn các Endpoint/Tag cụ thể.

Chọn định dạng và cấu hình

Chọn định dạng mong muốn của bạn, ví dụ: OpenAPI 3.0, và điều chỉnh mọi cài đặt dành riêng cho định dạng đó.

Các định dạng được hỗ trợ

Định dạng	Phiên bản / Ghi chú
OpenAPI / Swagger	Hỗ trợ `3.1`, `3.0` và `2.0`. Xuất dưới dạng `JSON` hoặc `YAML`. Bao gồm hỗ trợ cho các trường Apidog Extension.
HTML / Markdown	Tạo tài liệu tĩnh. Phù hợp nhất để chia sẻ ngoại tuyến.
Apidog	Định dạng gốc chứa toàn bộ dữ liệu dự án.
Postman	Xuất các collection tương thích với Postman.

Đối với Tài liệu ngoại tuyến, bạn có thể nhấp vào "Open URL" để xem trực tiếp dữ liệu thô trong trình duyệt của mình.

Tùy chọn xuất nâng cao

1. Xuất từ các Sprint Branch

Để xuất dữ liệu từ một Sprint Branch cụ thể:

Chuyển sang branch mong muốn bằng bộ chọn branch ở góc trên bên trái.

Đi tới Export Data. Apidog sẽ xuất toàn bộ dữ liệu từ branch hiện tại.

Lưu ý: Quy trình này hợp nhất sprint branch với main branch trong bộ nhớ để bảo đảm tính toàn vẹn dữ liệu (giải quyết các tham chiếu). Bạn không thể chọn một tập hợp con các endpoint khi xuất từ sprint branch.

2. Cấu hình OpenAPI tùy chỉnh

Đối với các thao tác xuất OpenAPI nâng cao, bạn có thể cấu hình quy tắc bao gồm thông qua Module Name > Overview > Export/Backup API Specification > Add.

Bạn có thể chọn bao gồm trường OperationId trong bản xuất, điều này hữu ích cho việc tạo code client. Tìm hiểu thêm về OperationId.

Câu hỏi thường gặp

H: Tại sao một số API bị thiếu trong bản xuất của tôi?
Đ: Điều này thường xảy ra nếu nhiều API có cùng chính xác Method và Path. Đặc tả OpenAPI yêu cầu các tổ hợp Method+Path là duy nhất. Apidog thực thi quy tắc này trong quá trình xuất (đặc biệt đối với các định dạng HTML/Markdown/OpenAPI). Hãy làm cho các endpoint của bạn trở nên duy nhất để giải quyết vấn đề này. Tìm hiểu thêm về Nhận dạng endpoint.

H: Tại sao thứ tự API khác nhau trong các bản xuất Markdown/HTML?
Đ: Đặc tả Swagger/OpenAPI nền tảng thường không áp đặt thứ tự nghiêm ngặt. Các bản xuất Markdown và HTML được tạo dựa trên dữ liệu đặc tả này, điều này có thể dẫn đến thứ tự sắp xếp khác với những gì bạn thấy trong Apidog client.

H: Tôi có thể xuất sang PDF hoặc Word không?
Đ: Xuất trực tiếp không được hỗ trợ. Chúng tôi khuyến nghị trước tiên nên xuất sang Markdown, sau đó sử dụng một công cụ như Typora hoặc Pandoc để chuyển đổi tệp Markdown thành PDF, Word hoặc các định dạng khác.

H: Các giá trị Authentication có được xuất không?
Đ: Có. Apidog tự động xuất các cấu hình Auth vào phần securitySchemes của tệp OpenAPI/Swagger. Không cần thao tác thủ công.

Cách xuất dữ liệu#

Các định dạng được hỗ trợ#

Tùy chọn xuất nâng cao#

1. Xuất từ các Sprint Branch#

2. Cấu hình OpenAPI tùy chỉnh#

Câu hỏi thường gặp#

Cách xuất dữ liệu

Các định dạng được hỗ trợ

Tùy chọn xuất nâng cao

1. Xuất từ các Sprint Branch

2. Cấu hình OpenAPI tùy chỉnh

Câu hỏi thường gặp