Tổng quan

Apidog cung cấp các khả năng xuất bản mạnh mẽ, giúp chuyển đổi đặc tả API của bạn thành tài liệu chuyên nghiệp và có tính tương tác. Dù bạn cần chia sẻ API nội bộ với nhóm của mình hay xuất bản tài liệu toàn diện ra công khai, Apidog đều cung cấp các tùy chọn linh hoạt để đáp ứng nhu cầu của bạn—từ các liên kết chia sẻ nhanh đến các trang tài liệu được tùy chỉnh đầy đủ với tên miền riêng của bạn.

Chia sẻ tài liệu API của bạn

Apidog cung cấp nhiều cách để chia sẻ và xuất bản tài liệu API của bạn, mỗi cách được thiết kế cho các trường hợp sử dụng khác nhau:

Chia sẻ nhanh: Tạo tài liệu API đẹp mắt chỉ bằng một lần nhấp từ các đặc tả API đã định nghĩa của bạn, rất phù hợp cho cộng tác nhanh

Tài liệu tương tác: Bật chức năng "Try it out" và tạo mã trực tuyến để khám phá API một cách thực hành

Trang tài liệu: Xuất bản các trang tài liệu toàn diện kết hợp nội dung Markdown với tài liệu API để tạo hướng dẫn người dùng hoàn chỉnh

Điều hướng tùy chỉnh: Tùy chỉnh thanh điều hướng của tài liệu để cải thiện trải nghiệm người dùng

Tên miền tùy chỉnh: Liên kết tài liệu với tên miền riêng của bạn để xây dựng thương hiệu chuyên nghiệp

URL tùy chỉnh: Xác định cấu trúc URL trang tùy chỉnh

Tùy chỉnh thư mục: Tùy chỉnh kiểu thư mục và hành vi khi nhấp trong tài liệu của bạn

Xuất bản nhiều phiên bản: Xuất bản và quản lý đồng thời nhiều phiên bản API

Ví dụ tài liệu

Xem một ví dụ thực tế về tài liệu đã xuất bản: https://docs.salla.dev/

Công nghệ API được hỗ trợ

Apidog cung cấp hỗ trợ toàn diện để lập tài liệu cho hầu như mọi công nghệ API. Dù bạn đang làm việc với API REST truyền thống, GraphQL hiện đại, kết nối WebSocket thời gian thực hay dịch vụ SOAP cấp doanh nghiệp, Apidog đều có thể đáp ứng.

Các công nghệ được hỗ trợ bao gồm: REST, SOAP, GraphQL, gRPC, WebSocket, SSE, và nhiều công nghệ khác.

Khám phá bộ sưu tập các thực hành tốt nhất về tài liệu và các ví dụ API thực tế của chúng tôi để xem cách các loại API khác nhau có thể được lập tài liệu một cách hiệu quả.

Tìm hiểu thêm

Khám phá các hướng dẫn và ví dụ chi tiết cho từng công nghệ API trong Công nghệ API được hỗ trợ.

Chia sẻ nhanh so với Xuất bản tài liệu

Apidog cung cấp hai phương thức xuất bản riêng biệt, mỗi phương thức được tối ưu hóa cho các tình huống khác nhau. Việc hiểu rõ sự khác biệt giữa chúng sẽ giúp bạn chọn phương pháp phù hợp với nhu cầu của mình.

Chia sẻ nhanh được thiết kế cho cộng tác nhanh chóng và linh hoạt—lý tưởng để chia sẻ các API cụ thể với thành viên nhóm hoặc đối tác bên ngoài trong quá trình phát triển. Xuất bản tài liệu được xây dựng để tạo các trang tài liệu chuyên nghiệp, hướng tới công chúng, với đầy đủ khả năng tùy chỉnh.

So sánh tính năng

Tính năng	Chia sẻ nhanh	Xuất bản tài liệu
Xuất bản một phần API	✓ Được hỗ trợ	Chỉ toàn bộ dự án
Tên miền tùy chỉnh	✗ Không được hỗ trợ	✓ Được hỗ trợ
Điều hướng tùy chỉnh	✗ Không được hỗ trợ	✓ Được hỗ trợ
Màu sắc và logo tùy chỉnh	✗ Không được hỗ trợ	✓ Được hỗ trợ
Xuất bản lên API Hub	✗ Không được hỗ trợ	✓ Được hỗ trợ

Khuyến nghị

Sử dụng Chia sẻ nhanh cho cộng tác nội bộ và rà soát API nhanh. Sử dụng Xuất bản tài liệu khi bạn cần một trang tài liệu chuyên nghiệp, mang thương hiệu riêng, dành cho công chúng.

Chia sẻ tài liệu API của bạn#

Công nghệ API được hỗ trợ#

Chia sẻ nhanh so với Xuất bản tài liệu#

So sánh tính năng#

Chia sẻ tài liệu API của bạn

Công nghệ API được hỗ trợ

Chia sẻ nhanh so với Xuất bản tài liệu

So sánh tính năng