Chia sẻ nhanh

Cộng tác API hiệu quả đòi hỏi việc chia sẻ tài liệu liền mạch. Chia sẻ nhanh loại bỏ sự kém hiệu quả của việc gửi qua lại các tệp Word hoặc PDF bằng cách cung cấp các liên kết tài liệu trực tuyến tức thời. Tính năng này cho phép giao tiếp nhanh giữa các nhóm, cho phép bạn chia sẻ các API endpoint cụ thể với cộng tác viên trong khi vẫn duy trì quyền kiểm soát đối với quyền truy cập, khả năng hiển thị và thời hạn.

Điều kiện tiên quyết

Trước khi tạo Chia sẻ nhanh, hãy bảo đảm bạn có:

Tài khoản Apidog có quyền truy cập vào một dự án

API endpoint hoặc tài liệu để chia sẻ

(Tùy chọn) Các môi trường đã được cấu hình nếu bạn muốn người đọc kiểm thử endpoint

Tạo Chia sẻ nhanh

Chuyển sang mô-đun Publish Docs trên thanh bên trái.

Ảnh chụp màn hình 2025-12-29 lúc 17.18.46@2x.png

Nhấp vào +New để tạo một Chia sẻ nhanh mới. Một dự án hỗ trợ nhiều Chia sẻ nhanh, có thể được phân phối cho các cộng tác viên khác nhau. Tất cả thành viên trong nhóm đều có thể xem các Chia sẻ nhanh do bất kỳ ai trong nhóm tạo.

Tùy chọn cấu hình

Trong hộp thoại New Share, bạn có thể tùy chỉnh các tùy chọn sau:

Title: Tên của chia sẻ này, chỉ hiển thị trong nhóm Apidog, dùng để nhận diện nội bộ, không hiển thị trong tài liệu được chia sẻ.

Environments: Chọn các môi trường khả dụng trong tài liệu trực tuyến. Theo mặc định, không có môi trường nào được chọn. Bạn có thể chọn nhiều môi trường. Các môi trường đã chọn sẽ hiển thị cho người đọc trong tài liệu và có thể được dùng để gửi yêu cầu khi sử dụng "Try it out".

Cloud Mock Environment

Nếu bạn chọn môi trường Cloud mock khi tạo tài liệu, bạn đang cung cấp cho người đọc một môi trường sandbox đơn giản để kiểm thử API mà không ảnh hưởng đến hệ thống production.

Document content: Tài liệu có hai thành phần tùy chọn: Base URL và Request samples. Bạn có thể chọn có hiển thị chúng trong tài liệu hay không.

Base URL: Đây là base URL được thiết lập trong môi trường. Nếu được chọn, mỗi interface trong tài liệu sẽ hiển thị URL đầy đủ; nếu không được chọn, URL trong tài liệu sẽ bắt đầu bằng "/".

Owners: Hiển thị chủ sở hữu của tài liệu API này.

Request samples: Có hiển thị mã ví dụ để gọi yêu cầu hay không. Xem request samples để biết chi tiết.

Hiển thị thời gian 'Last Modified' phía trên mô tả endpoint.

Hiển thị thời gian 'Last Modified' ở cuối tài liệu.

Allow 'Export', 'Clone' Data: Có cho phép người đọc xuất và clone dữ liệu ở định dạng OAS/Markdown/HTML/Apidog hay không.

Scope to share: Chọn các API endpoint và Markdown cần đưa vào chia sẻ này. Bạn có thể chọn theo thư mục hoặc bộ lọc và loại trừ theo thẻ. Bạn cũng có thể chọn share the entire folder.

Security: Bạn có thể thiết lập liệu có yêu cầu mật khẩu để truy cập tài liệu này hay không, cũng như thời gian hết hạn của tài liệu này. Nếu không chọn thời gian hết hạn, tài liệu sẽ không bao giờ hết hạn.

Show API Fields: Bạn có thể thiết lập liệu các trường này có được hiển thị trong tài liệu hay không. Bao gồm: Owners, Update time, OperationId, Original link, Authorization Required.

Language: Thiết lập ngôn ngữ tại đây sẽ ảnh hưởng đến văn bản cố định theo chức năng trong tài liệu, chẳng hạn như "Query Params", "Request samples", v.v., nhưng sẽ không ảnh hưởng đến văn bản được viết trong nội dung tài liệu API.

CORS Proxy: Bạn có thể triển khai và cấu hình máy chủ CORS proxy để xử lý các yêu cầu endpoint trên tài liệu API. Tìm hiểu thêm.

Advanced Settings: Cấu hình các tùy chọn như Hide 'Try it out' Button và Hide 'Powered by Apidog'.

Mẫu yêu cầu

Bạn có thể chọn có hiển thị các mẫu mã yêu cầu khi tạo chia sẻ hay không.
Cách tùy chỉnh mẫu yêu cầu:

Trong Settings → Feature settings → Endpoint feature settings → Endpoint fields, bật trường Request samples

Trong Endpoint → Edit, một mô-đun Request samples sẽ xuất hiện ở cuối

Nhấp vào Custom Request Code Samples để thêm mẫu bằng các ngôn ngữ bạn ưu tiên

Ảnh chụp màn hình 2025-12-29 lúc 17.21.25@2x.png

Chia sẻ toàn bộ thư mục

Chia sẻ nhanh hỗ trợ Share entire folder, rất phù hợp cho các tình huống bạn tiếp tục thêm hoặc xóa tài liệu sau khi chia sẻ. Khi được bật, cộng tác viên sẽ tự động truy cập tất cả tài liệu trong thư mục mà không yêu cầu bạn điều chỉnh thiết lập chia sẻ cho từng tài liệu mới.

Trong phần Scope to Share, chọn Manual Selection để thấy tùy chọn Share entire folder. Khi được bật, cộng tác viên sẽ tự động truy cập tất cả tài liệu trong thư mục.

Cấu hình CORS Proxy

Khi chia sẻ tài liệu API với người dùng bên ngoài, họ có thể gặp sự cố Cross-Origin Resource Sharing (CORS) khi kiểm thử endpoint trực tiếp trong trình duyệt. CORS proxy giải quyết vấn đề này bằng cách định tuyến yêu cầu thông qua một proxy agent được chỉ định, vượt qua các hạn chế CORS của trình duyệt và cho phép kiểm thử API liền mạch.

Để cấu hình CORS proxy, hãy nhấp vào tùy chọn thiết lập khi tạo tài liệu chia sẻ mới. Theo mặc định, Apidog cung cấp Cloud Agent để quản lý các yêu cầu endpoint trên tất cả tài liệu chia sẻ.

Tùy chọn CORS Proxy

Chọn tùy chọn CORS proxy phù hợp nhất với nhu cầu của bạn:

Cloud Proxy: Sử dụng Cloud Agent của Apidog để xử lý các yêu cầu endpoint. Lưu ý: Cloud Agent không thể truy cập các endpoint trên mạng nội bộ

Browser Extensions: Sử dụng tiện ích mở rộng trình duyệt được cài đặt trong trình duyệt của người dùng. Người dùng không có tiện ích mở rộng sẽ được nhắc cài đặt trước khi gửi yêu cầu

No Proxy: Yêu cầu được gửi trực tiếp từ trình duyệt của người dùng. Hãy bảo đảm máy chủ endpoint của bạn được cấu hình để xử lý CORS đúng cách

Self-hosted Request Proxy Agent: Sử dụng Self-hosted Request Proxy Agent được triển khai trong hạ tầng của bạn để xử lý các yêu cầu endpoint

Điều kiện tiên quyết#

Tạo Chia sẻ nhanh#

Tùy chọn cấu hình#

Mẫu yêu cầu#

Chia sẻ toàn bộ thư mục#

Cấu hình CORS Proxy#

Tùy chọn CORS Proxy#