Chia sẻ tài liệu API

Sau khi API của bạn đã được phát triển và debug thành công, Apidog giúp dễ dàng tạo tài liệu chuyên nghiệp mà bạn có thể chia sẻ với nhóm của mình, các bên liên quan hoặc nhà phát triển bên ngoài.

Hướng dẫn từng bước

Làm theo các bước sau để tạo và chia sẻ tài liệu API của bạn:

Bước 1: Truy cập mô-đun Share Docs

1. Mở dự án Apidog của bạn

2. Chuyển sang mô-đun Share Docs từ thanh bên

Bước 2: Tạo một chia sẻ mới

1. Nhấp vào nút New để khởi tạo một chia sẻ tài liệu mới
2. Thao tác này sẽ mở hộp thoại cấu hình chia sẻ

Bước 3: Cấu hình cài đặt chia sẻ

Hoàn tất các cài đặt sau trong phần cấu hình chia sẻ:

Cài đặt	Mô tả	Hành động được khuyến nghị
Name	Đặt cho chia sẻ của bạn một tên có tính mô tả	Sử dụng tên dự án + phiên bản (ví dụ: "Pet Store API v1.2")
Environments	Chọn những môi trường cần bao gồm	Chọn tất cả môi trường để có tài liệu toàn diện
Access	Thiết lập quyền hiển thị	Chọn cấp độ truy cập phù hợp với đối tượng của bạn


3. Nhấp vào Save để tạo chia sẻ của bạn

Bước 4: Truy cập tài liệu của bạn

1. Chia sẻ mới của bạn sẽ xuất hiện trong danh sách chia sẻ
2. Nhấp vào Open để xem tài liệu của bạn trong trình duyệt web
3. Tài liệu sẽ mở trong một tab mới với URL có thể chia sẻ

Bước 5: Khám phá các tính năng của tài liệu

Tài liệu của bạn bao gồm các tính năng mạnh mẽ:

• Trình khám phá API tương tác: Điều hướng các endpoint trong cây thư mục bên trái

• Try It Out: Gửi các yêu cầu trực tiếp ngay từ tài liệu

• Tạo mã: Tạo các đoạn mã yêu cầu và mã mô hình dữ liệu

• Chuyển đổi môi trường: Kiểm thử các môi trường API khác nhau

Tùy chỉnh và xuất bản nâng cao

Apidog cung cấp thêm các tùy chọn tùy chỉnh cho tài liệu của bạn:

Tính năng	Mô tả	Trường hợp sử dụng
Bố cục tùy chỉnh	Điều chỉnh cấu trúc và giao diện của tài liệu	Tính nhất quán thương hiệu, tối ưu hóa trải nghiệm người dùng
Tên miền tùy chỉnh	Sử dụng tên miền riêng của bạn	Trình bày chuyên nghiệp, nhận diện thương hiệu
URL tùy chỉnh	Tạo các URL dễ nhớ và có ý nghĩa	Tiếp thị, dễ chia sẻ, lợi ích SEO
Kiểm soát truy cập	Thiết lập quyền chi tiết	Nhóm nội bộ, đối tác bên ngoài, truy cập công khai

---

Tìm hiểu thêm về thiết kế, kiểm thử, mock và xuất bản API trong Apidog.