Tài liệu API đã xuất bản của Apidog cung cấp chế độ xem API của bạn một cách tương tác và toàn diện. Khi người dùng truy cập URL tài liệu của bạn, họ sẽ thấy phần trình bày có cấu trúc rõ ràng cho từng endpoint, với nhiều phần được thiết kế để dễ hiểu và dễ kiểm thử.Cấu trúc tài liệu#
Mỗi trang endpoint bao gồm các phần sau:Siêu dữ liệu: Thông tin endpoint cơ bản
Try it out: Kiểm thử API tương tác
Yêu cầu: Thông số tham số và body
Mẫu yêu cầu: Ví dụ mã bằng nhiều ngôn ngữ khác nhau
Phản hồi: Th ông số phản hồi và ví dụ
Siêu dữ liệu#
Phần này hiển thị thông tin endpoint thiết yếu như URL, phương thức HTTP, thời gian sửa đổi và mô tả. Bạn có thể chọn các trường sẽ hiển thị khi tạo tài liệu.Trạng thái endpoint#
Các endpoint có trạng thái "Released" sẽ không hiển thị thẻ trạng thái. Các endpoint có trạng thái khác (như "Developing") sẽ hiển thị thẻ trạng thái sau tên endpoint. Các endpoint có trạng thái "Deprecated" sẽ xuất hiện dưới dạng "tên endpoint" trong cây thư mục bên trái.Mô tả endpoint#
Nội dung Markdown trong mô tả endpoint được kết xuất và hiển thị ở cuối phần siêu dữ liệu.Try It Out#
Nhấp vào "Try it out" để mở rộng lớp kiểm thử tương tác, nơi bạn có thể gửi yêu cầu, chỉnh sửa tham số và chuyển đổi môi trường. Các môi trường có sẵn là những môi trường đã được chọn khi tạo tài liệu.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. Sử dụng biến#
Nếu {{variables}} được sử dụng trong các ví dụ yêu cầu, người đọc phải thiết lập giá trị biến trước khi gửi yêu cầu.Sử dụng thông tin xác thực#
Bạn có thể cấu hình xác thực ở cấp API hoặc cấp thư mục trong phần cài đặt Auth của dự án. Sử dụng security schemes hoặc định nghĩa cài đặt theo cách thủ công.Sau khi cấu hình cài đ ặt xác thực—ví dụ: sử dụng xác thực Bearer Token—bạn sẽ thấy phần "Credentials" ở đầu bảng "Publish Documentation", nơi bạn có thể nhập trực tiếp giá trị token.Lợi ích chính của phương pháp cấu hình này là thông tin xác thực có thể được chia sẻ giữa các API khác nhau. Nếu nhiều API tham chiếu cùng một security scheme hoặc loại xác thực, bạn chỉ cần nhập thông tin xác thực một lần, và các API khác có thể tự động sử dụng lại thông tin đó.Các thông tin xác thực này được mã hóa và lưu trữ trong LocalStorage của trình duyệt, đồng thời được quản lý dựa trên phiên trình duyệt. Trong cùng một phiên, chúng có thể được chia sẻ trên nhiều cửa sổ và tab. Khi trình duyệt được đóng và phiên kết thúc, các thông tin xác thực này sẽ tự động trở nên không hợp lệ.Cụ thể hơn: thông tin xác thực được lưu trữ trong LocalStorage được mã hóa, trong khi khóa giải mã được lưu trong cookie phiên. Mặc dù dữ liệu trong LocalStorage được duy trì lâu dài, khóa giải mã trong cookie phiên sẽ hết hạn ngay khi trình duyệt được đóng. Do đó, dữ liệu đã mã hóa không còn có thể được giải mã hoặc truy cập, và bạn sẽ cần nhập lại thông tin xác thực vào lần tiếp theo truy cập.Yêu cầu#
Phần này hiển thị thông số tham số và body. Apidog hỗ trợ hai kiểu hiển thị tham số—Modern hoặc Classic—mà bạn có thể chọn trong Settings → Feature Settings → Endpoint Feature Settings.Mẫu yêu cầu#
Các mẫu mã yêu cầu bằng nhiều ngôn ngữ lập trình khác nhau. Bạn có thể chọn có hiển thị mô-đun này hay không khi tạo chia sẻ.Phản hồi#
Thông số phản hồi và ví dụ, được hiển thị giống như trong client Apidog.Xuất#
Nếu bạn đã chọn "Allow exporting data" khi tạo tài liệu, người đọc sẽ thấy tùy chọn Export ở góc dưới bên phải và ở cuối cùng của tài liệu.Người đọc có thể chọn giữa "Clone" hoặc "Export". "Export" hỗ trợ xuất ở các định dạng OAS, HTML, Markdown và Apidog. Modified at 2026-06-11 10:23:06
