Apidog Docs
🇻🇳 Tiếng Việt
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇻🇳 Tiếng Việt
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇻🇳 Tiếng Việt
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. Xuất bản tài liệu API
  • Trung tâm Học tập Apidog
  • Bắt đầu
    • Giới thiệu về Apidog
    • Các khái niệm cơ bản trong Apidog
    • Điều hướng Apidog
    • Bắt đầu nhanh
      • Tổng quan
      • Tạo một Endpoint
      • Tạo yêu cầu
      • Thêm một khẳng định
      • Tạo kịch bản kiểm thử
      • Chia sẻ tài liệu API
      • Khám phá thêm
    • Di chuyển sang Apidog
      • Tổng quan
      • Nhập thủ công
      • Nhập theo lịch (Liên kết nguồn dữ liệu)
      • Tùy chọn nhập
      • Xuất dữ liệu
      • Nhập từ
        • Nhập từ Postman
        • Nhập OpenAPI Spec
        • Nhập cURL
        • Nhập Markdown
        • Nhập từ Insomnia
        • Nhập từ apiDoc
        • Nhập tệp .har
        • Nhập WSDL
  • Dữ liệu API mock
    • Tổng quan
    • Smart Mock
    • Mock tùy chỉnh
    • Trình tự ưu tiên Mock
    • Mock Scripts
    • Cloud Mock
    • Self-Hosted Runner Mock
    • Ngôn ngữ Mock (Locales)
  • Tài khoản và tùy chọn
    • Cài đặt tài khoản
    • Tạo Token truy cập OpenAPI
    • Thông báo
    • Cài đặt ngôn ngữ
    • Phím tắt
    • Cấu hình Proxy Mạng
    • Sao lưu dữ liệu
    • Cập nhật Apidog
    • Xóa tài khoản
    • Tính năng thử nghiệm
  • Gửi yêu cầu
    • Tổng quan
    • Gỡ lỗi SSE
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP hoặc WebService
    • GraphQL
    • gRPC
    • Sử dụng Tác nhân Proxy Yêu cầu để Gỡ lỗi
    • Tạo yêu cầu
      • Lịch sử yêu cầu
      • Cơ bản về yêu cầu
      • Tham số và Body
      • Header của yêu cầu
      • Cài đặt yêu cầu
      • Gỡ lỗi yêu cầu
      • Lưu yêu cầu dưới dạng Endpoint
      • HTTP/2
    • Xác thực và phân quyền
      • Tổng quan
      • Chứng chỉ CA và Chứng chỉ Client
      • Các loại ủy quyền
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Xác thực Hawk
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Phản hồi và cookie
      • Xem phản hồi API
      • Quản lý Cookie
      • Tổng quan
  • Phát triển và gỡ lỗi API
    • Tổng quan
    • Tạo yêu cầu
    • Gửi yêu cầu
    • Trường hợp gỡ lỗi
    • Trường hợp kiểm thử
    • Giá trị động
    • Xác thực phản hồi
    • Design-First vs Request-First
    • Tạo mã
    • Môi trường và biến
      • Tổng quan
      • Sử dụng biến
      • Quản lý môi trường
    • Bí mật trong vault
      • Tổng quan
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Mô-đun giá trị động
      • Hãng hàng không
      • Animal
      • Màu sắc
      • Commerce
      • Company
      • Cơ sở dữ liệu
      • Kiểu dữ liệu
      • Ngày
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • Hình ảnh
      • Internet
      • Vị trí
      • Lorem
      • Music
      • Number
      • Person
      • Phone
      • Science
      • String
      • Hệ thống
      • Vehicle
      • Từ
    • Bộ xử lý trước và sau
      • Tổng quan
      • Khẳng định
      • Trích xuất biến
      • Chờ
      • Bảo mật
      • Thao tác cơ sở dữ liệu
        • Tổng quan
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • Sử dụng script
        • Tổng quan
        • Script tiền xử lý
        • Tập lệnh hậu xử lý
        • Public Scripts
        • Tài liệu tham khảo về Postman Scripts
        • Gọi các ngôn ngữ lập trình khác
        • Sử dụng thư viện JS
        • Trực quan hóa phản hồi
        • Ví dụ script
          • Tập lệnh khẳng định
          • Sử dụng biến
          • Sửa đổi yêu cầu
          • Các ví dụ khác
    • Gỡ lỗi API
      • AI Agent Debugger
      • A2A Debugger
  • Thiết kế API
    • Tổng quan
    • Tạo một dự án API mới
    • Kiến thức cơ bản về Endpoint
    • Hướng dẫn thiết kế API
    • Mô-đun
    • Cấu hình nhiều ví dụ về body của yêu cầu
    • Thành phần
    • Trường Chung
    • Tham số toàn cục
    • Lịch sử thay đổi endpoint
    • Bình luận
    • Quản lý Endpoint Hàng loạt
    • Custom Protocol API
    • Chế độ Spec-first (Beta)
    • Lược đồ bảo mật
      • Tổng quan
      • Tạo Security Scheme
      • Sử dụng Lược đồ bảo mật
      • Lược đồ bảo mật trong tài liệu trực tuyến
    • Tính năng nâng cao
      • Trường Endpoint Tùy chỉnh
      • Các kịch bản kiểm thử được liên kết
      • Trạng thái Endpoint
      • Giao diện của Danh sách Tham số
      • Nhận dạng duy nhất endpoint
    • Schemas
      • Tổng quan
      • Tạo Schema Mới
      • Xây dựng Schema
      • Tạo Schema từ JSON, v.v.
      • oneOf, allOf, anyOf
      • Sử dụng Discriminator
  • Kiểm thử API
    • Tổng quan
    • Kịch bản kiểm thử
      • Tạo một kịch bản kiểm thử
      • Truyền dữ liệu giữa các yêu cầu
      • Điều kiện điều khiển luồng
      • Đồng bộ dữ liệu từ endpoint và trường hợp endpoint
      • Nhập Endpoint và Endpoint Case từ các dự án khác
      • Xuất Kịch bản Kiểm thử
    • Báo cáo kiểm thử
      • Báo cáo kiểm thử
    • Chạy kịch bản kiểm thử
      • Chạy một kịch bản kiểm thử
      • Chạy hàng loạt các kịch bản kiểm thử
      • Kiểm thử dựa trên dữ liệu
      • Dữ liệu kiểm thử dùng chung
      • Tác vụ đã lên lịch
      • Quản lý môi trường runtime của API từ các dự án khác
    • Bộ kiểm thử
      • Tổng quan
      • Tạo một bộ kiểm thử
      • Điều phối Bộ kiểm thử
      • Chạy bộ kiểm thử cục bộ
      • Chạy Bộ Kiểm Thử Qua CLI
      • Tác vụ đã lên lịch
    • Kiểm thử API
      • Kiểm thử tích hợp
      • Kiểm thử hiệu năng
      • Kiểm thử End-to-End
      • Kiểm thử hồi quy
      • Kiểm thử hợp đồng
    • Apidog CLI
      • Tổng quan
      • Cài đặt và chạy Apidog CLI
      • Tùy chọn Apidog CLI
    • CI/CD
      • Tổng quan
      • Tích hợp với Github Actions
      • Tích hợp với Gitlab
      • Tích hợp với Jenkins
      • Kích hoạt kiểm thử bằng Git Commit
  • Xuất bản tài liệu API
    • Tổng quan
    • Các công nghệ API được hỗ trợ
    • Chia sẻ nhanh
    • Xem tài liệu API
    • Tài liệu Markdown
    • Xuất bản site tài liệu
    • Trang đăng nhập tùy chỉnh
    • Bố cục tùy chỉnh
    • CSS, JavaScript, HTML tùy chỉnh
    • Tên miền tùy chỉnh
    • Tính năng AI
    • Cài đặt SEO
    • Cài đặt nâng cao
      • Tìm kiếm tài liệu
      • Proxy CORS
      • Tích hợp Google Analytics
      • Cài đặt cây thư mục
      • Cài đặt khả năng hiển thị
      • Nhúng giá trị vào URL tài liệu
    • Phiên bản API
      • Tổng quan
      • Tạo phiên bản API
      • Xuất bản các phiên bản API
      • Chia sẻ endpoint theo phiên bản API
  • Nhánh
    • Tổng quan
    • Tạo một Sprint Branch
    • Kiểm thử API trong một nhánh
    • Thiết kế API trong một nhánh
    • Hợp nhất các nhánh Sprint
    • Quản lý Nhánh Sprint
    • AI Branch (Beta)
  • Tính năng AI
    • Tổng quan
    • Bật các tính năng AI
    • Tạo Trường hợp Kiểm thử
    • Sửa đổi Schema bằng AI
    • Kiểm tra tuân thủ endpoint
    • Kiểm tra mức độ hoàn chỉnh của tài liệu API
    • Đặt tên trường bằng AI
    • Câu hỏi thường gặp
  • Máy chủ MCP Apidog
    • Tổng quan
    • Kết nối dự án Apidog với AI
    • Kết nối tài liệu đã xuất bản với AI
    • Kết nối tệp OpenAPI với AI
  • Thực hành tốt nhất
    • Xử lý chữ ký API
    • Truy cập các API được bảo vệ bằng OAuth 2.0
    • Quy trình cộng tác
    • Quản lý trạng thái xác thực
  • Không gian ngoại tuyến
    • Tổng quan
  • Apidog Europe
    • Apidog Europe
  • Quản trị
    • Quản lý dự án
      • Quản lý dự án
      • Cài đặt thông báo
      • Quản lý thành viên dự án
      • Tài nguyên dự án
        • Kết nối cơ sở dữ liệu
        • Kết nối Git
    • Quản lý nhóm
      • Quản lý nhóm
      • Quản lý thành viên nhóm
      • Hoạt động của nhóm
      • Vai trò & Quyền của Nhóm
      • Tài nguyên nhóm
        • General Runner
        • Biến nhóm
        • Request Proxy Agent
      • Cộng tác thời gian thực
        • Cộng tác nhóm
    • Danh sách kiểm tra onboarding
      • Khái niệm cơ bản
      • Hướng dẫn nhập môn
    • Quản lý tổ chức
      • Quản lý Tổ chức
      • Vai trò & Quyền trong Tổ chức
      • Quản lý gói
        • Người quản lý thanh toán trong tổ chức
      • Đăng nhập một lần (SSO)
        • Tổng quan về SSO
        • Cấu hình Microsoft Entra ID
        • Cấu hình Okta
        • Cấu hình SSO cho một tổ chức
        • Quản lý tài khoản người dùng
        • Ánh xạ Nhóm tới Đội
      • Cấp phát SCIM
        • Giới thiệu về cấp phát SCIM
        • Microsoft Entra ID
        • Okta
      • Tài nguyên tổ chức
        • Self-Hosted Runner
  • Thanh toán
    • Tổng quan
    • Credits
    • Nâng cấp gói của bạn
    • Phương thức thanh toán thay thế
    • Quản lý đăng ký
    • Chuyển các nhóm trả phí vào tổ chức
  • Tiện ích bổ sung
    • API Hub
    • Apidog Intellij IDEA Plugin
    • Tiện ích mở rộng trình duyệt
      • Chrome
      • Microsoft Edge
    • Proxy yêu cầu
      • Proxy yêu cầu trên Web
      • Proxy yêu cầu trong tài liệu được chia sẻ
      • Proxy yêu cầu trong Client
  • Dữ liệu và bảo mật
    • Lưu trữ và bảo mật dữ liệu
    • Quyền riêng tư và bảo mật dữ liệu người dùng
    • Định tuyến yêu cầu và bảo mật dữ liệu
  • Tham chiếu
    • Phương pháp tiếp cận API Design-First
    • Phần mở rộng Đặc tả OpenAPI của Apidog
    • JSONPath
    • XPath
    • Biểu thức chính quy
    • JSON Schema
    • Định dạng tệp CSV
    • Cài đặt môi trường Java
    • Môi trường triển khai Runner
    • Cú pháp Markdown của Apidog
    • Tiện ích mở rộng Swagger của Apidog
      • Tổng quan
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Tiện ích mở rộng JSON Schema của Apidog
      • Tổng quan
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • Trung tâm hỗ trợ
  1. Xuất bản tài liệu API

Xuất bản site tài liệu

Việc xuất bản một site tài liệu sẽ tạo ra một nơi lưu trữ lâu dài, được tùy chỉnh đầy đủ cho tài liệu API của bạn—khác với tính năng Quick Share, vốn được thiết kế cho cộng tác tạm thời. Trong khi Quick Share tạo các liên kết có thể chia sẻ để giao tiếp nhanh chóng trong nội bộ và bên ngoài, Publish Docs Sites cung cấp các tùy chọn tùy chỉnh toàn diện, bao gồm tên miền tùy chỉnh, thiết kế theo thương hiệu, kiểm soát điều hướng và các tính năng nâng cao. Điều này khiến tính năng này trở nên lý tưởng để tạo tài liệu API chuyên nghiệp, hướng đến công chúng và đại diện cho thương hiệu của bạn.

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

Trước khi xuất bản một site tài liệu, hãy đảm bảo bạn có:
Tài khoản Apidog với một dự án chứa tài liệu API
Quyền quản trị viên đối với dự án
(Tùy chọn) Một tên miền tùy chỉnh nếu bạn dự định sử dụng URL theo thương hiệu

Cấu hình sơ bộ#

Xuất bản site tài liệu của bạn#

Để xuất bản site tài liệu của bạn, hãy điều hướng đến mô-đun Publish Docs và nhấp vào site chính mặc định, sau đó nhấp vào nút Publish.
hình ảnh.png

Cài đặt khả năng hiển thị của site tài liệu#

Yêu cầu phiên bản
Phiên bản Apidog phải ≥ 2.7.15 để truy cập các tính năng hiển thị này.
Sau khi nhấp vào nút Publish, bạn có thể kiểm soát khả năng hiển thị của site tài liệu đã xuất bản dựa trên các yêu cầu bảo mật và truy cập của mình. Nhấp vào nút Publish right now để đưa site của bạn hoạt động với các cài đặt hiển thị đã chọn.
hình ảnh.png
Công khai
Các site tài liệu của bạn sẽ có thể truy cập được đối với tất cả người dùng internet. Bạn cũng có thể chọn xuất bản tài liệu API của mình trên API Hub, một nền tảng do Apidog vận hành nhằm giúp người dùng khám phá và tìm hiểu các API.
Được bảo vệ bằng mật khẩu
Danh sách IP được phép
Danh sách email được phép
Trang đăng nhập tùy chỉnh

Phạm vi xuất bản#

Theo mặc định, phạm vi xuất bản tài liệu được đặt thành tất cả tài nguyên Shared. Bạn có thể cấu hình điều này trong APIs. Để biết thêm chi tiết, vui lòng tham khảo cài đặt khả năng hiển thị.

Cấu hình nâng cao#

Try It#

Bạn có thể bật tính năng Try It cho các trang tài liệu của mình, để người dùng có thể trực tiếp gửi yêu cầu API ngay trên chính trang tài liệu.
hình ảnh.png

Phiên bản phát hành#

Bạn có thể tạo và xuất bản nhiều phiên bản tài liệu API của mình. Tìm hiểu thêm về việc xuất bản phiên bản API.
cài đặt phát hành cho tài liệu API.jpg
Tài nguyên liên quan
Người dùng tài liệu có thể sửa đổi Base URL trong tài liệu được chia sẻ như thế nào?
Cách chia sẻ header (ví dụ: Token) trong tài liệu trực tuyến của Apidog?

Cài đặt tên miền#

Tên miền do Apidog cung cấp: Tài liệu của bạn sẽ có một tên miền phụ Apidog mặc định, chẳng hạn như https://vhh2uhkjv7.apidog.io. Bạn cũng có thể sửa đổi thủ công. Tất cả tài liệu Apidog đều sử dụng tên miền apidog.io.
Tên miền tùy chỉnh: Bạn có thể liên kết tài liệu Apidog với tên miền riêng của mình. Tìm hiểu thêm về Tên miền tùy chỉnh.
cài đặt tên miền cho tài liệu API.jpg

Tùy chỉnh giao diện#

Bạn có thể tùy chỉnh giao diện và bố cục cho tài liệu API.
hình ảnh.png
Bạn có thể xem trước tài liệu của mình theo thời gian thực tại đây và lưu lại khi hài lòng với kết quả.
Apidog-01.gif
Giao diện
Bố cục & Điều hướng
Trang đích tùy chỉnh
CSS, JavaScript và HTML tùy chỉnh
Trong Cài đặt giao diện, bạn có thể cấu hình nhiều tùy chọn cơ bản cho tài liệu API của mình, bao gồm Tiêu đề, Logo và Favicon.
hình ảnh.png
Trong Nội dung hiển thị, bạn có thể tùy chỉnh các trường sẽ hiển thị trong tài liệu API, bao gồm: Base URL, Người duy trì và Thời gian sửa đổi gần nhất.
hình ảnh.png

Cài đặt SEO#

Cài đặtMô tả
Metadata toàn cụcCấu hình metadata mặc định cho toàn bộ site.
Tệp RobotsTệp robots.txt hướng dẫn công cụ tìm kiếm về những trang cần thu thập dữ liệu và hiển thị trong kết quả tìm kiếm.
Tệp SitemapTệp sitemap.xml cung cấp cho công cụ tìm kiếm danh sách đầy đủ tất cả các trang trên site của bạn để lập chỉ mục tốt hơn.
Quy tắc chuyển hướng tài liệuChuyển hướng người dùng đến đúng trang tài liệu khi URL thay đổi, ngăn chặn liên kết hỏng.
Quy tắc URL & SlugXác định cấu trúc URL và định dạng slug cho các trang tài liệu của bạn.

Cài đặt nâng cao#

Tính năngMô tả
Tìm kiếm tài liệuTích hợp với Algolia để cung cấp khả năng tìm kiếm nâng cao cho tài liệu API đã xuất bản của bạn. Tính năng Ask AI mở khóa khả năng hỏi đáp dạng hội thoại được hỗ trợ bởi AI ngay trong phần tìm kiếm tài liệu của bạn.
CORS ProxyChỉ định một CORS proxy để ngăn các vấn đề cross-origin có thể phát sinh từ các hạn chế bảo mật của trình duyệt.
Google AnalyticsBật tích hợp với Google Analytics để theo dõi và phân tích lưu lượng truy cập vào site tài liệu của bạn.
Xuất bản lên API HubXuất bản tài liệu của bạn lên API Hub, một nền tảng mở để chia sẻ và khám phá API.
Mô tảĐặt mô tả sẽ được hiển thị trên API Hub nếu dự án được xuất bản tại đó.
Cho phép xuất dữ liệu, sao chép dữ liệuCho phép người dùng xuất hoặc sao chép dữ liệu tài liệu từ nhánh chính.

Xuất bản nhiều site tài liệu#

Để xuất bản tài liệu trên các kênh khác nhau trong cùng một dự án, bạn có thể tạo thêm các site tài liệu trong quá trình xuất bản. Để quản lý dễ dàng hơn, bạn có thể sao chép cấu hình của site chính cho từng site mới. Mỗi site phụ cũng có thể có một tên miền tùy chỉnh riêng.
giới thiệu xuất bản site tài liệu-05.png
Chỉ các site phụ mới cho phép bạn đặt phạm vi hiển thị cho tài liệu đã xuất bản, cho phép bạn chọn tài nguyên nào có thể truy cập công khai.
giới thiệu xuất bản site tài liệu-06.png
Modified at 2026-06-11 10:23:06
Previous
Tài liệu Markdown
Next
Trang đăng nhập tùy chỉnh
Built with