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

Tên miền tùy chỉnh

Tài liệu API chuyên nghiệp xứng đáng có một tên miền chuyên nghiệp. Theo mặc định, tài liệu Apidog có thể truy cập trên tên miền <subdomain>.apidog.io. Tuy nhiên, bạn có thể tùy chỉnh điều này bằng cách thiết lập tên miền riêng, cho phép đối tượng người dùng của bạn truy cập tài liệu trên một tên miền phù hợp với thương hiệu của tổ chức.

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

Trước khi thiết lập tên miền tùy chỉnh, hãy đảm bảo bạn có:
Quyền quản trị đối với dự án Apidog
Quyền sở hữu hoặc quyền kiểm soát tên miền bạn muốn sử dụng
Quyền truy cập vào cài đặt DNS của tên miền
(Đối với phương thức Reverse Proxy) Hiểu biết về cấu hình CDN hoặc reverse proxy

Bắt đầu thiết lập tên miền tùy chỉnh#

Để truy cập cài đặt tên miền tùy chỉnh, hãy điều hướng đến menu Publish Docs trong thanh bên, sau đó vào trang cài đặt Publish. Bạn sẽ thấy phần Custom Domain, nơi bạn có thể nhấp vào nút Edit để bắt đầu thiết lập.
CleanShot 2025-12-29 lúc 17.31.22@2x.png

Các phương thức thiết lập tên miền tùy chỉnh#

Có hai loại tùy chọn để thiết lập tên miền tùy chỉnh:
1.
CNAME (Khuyến nghị): Dễ thiết lập và duy trì nhất; hoạt động cho cả tên miền phụ và tên miền gốc, mang lại tính linh hoạt tối đa.
2.
Reverse Proxy (Nâng cao): Yêu cầu sử dụng Content Delivery Network (CDN) hoặc thiết lập reverse proxy trên máy chủ riêng của bạn; được khuyến nghị cho người dùng quen thuộc với các công nghệ này.

Cấu hình CNAME#

Phạm vi áp dụng
Phần này chỉ áp dụng nếu bạn đã chọn tùy chọn CNAME ở bước trước.
Việc cấu hình DNS diễn ra bên ngoài Apidog, tại nhà cung cấp DNS mà bạn đang sử dụng cho tên miền của mình.
Bước này gồm hai phần:
1.
Cấu hình một bản ghi CNAME
2.
Chờ các thay đổi có hiệu lực

Cấu hình bản ghi CNAME#

Tên trường và các bước cấu hình có thể khác nhau giữa các bảng điều khiển DNS, nhưng các khái niệm cốt lõi vẫn giống nhau. Nếu bạn không chắc chắn, hãy xác minh với nhà cung cấp DNS của bạn.
type là loại bản ghi DNS mà bạn muốn tạo. Tại đây, bạn cần chọn CNAME.
name hoặc DNS entry là nơi bạn nhập tên miền phụ của mình. Bạn có thể cần nhập đầy đủ (ví dụ: docs.example.com) hoặc có thể chỉ cần nhập phần đứng trước tên miền apex của bạn (ví dụ: docs). Nếu bạn không chắc nên dùng định dạng nào, hãy kiểm tra với nhà cung cấp DNS.
target, value hoặc destination là nơi tên miền phụ sẽ được trỏ đến. Bạn sẽ thấy giá trị này trong cài đặt Publish của Apidog khi chọn tùy chọn DNS CNAME. Giá trị này sẽ có dạng tương tự {docsSiteId}.apidog.io. Bạn nên nhập đầy đủ giá trị này (ví dụ: 12345678.apidog.io).
Bạn cũng có thể thấy một trường có tên TTL, viết tắt của Time To Live. Đây là số giây mà bản ghi DNS có thể được lưu trong bộ nhớ đệm. Nếu bạn không chắc nên đặt giá trị nào, chúng tôi khuyến nghị chọn Auto hoặc giữ nguyên giá trị mặc định.
Dưới đây là ví dụ về cấu hình đúng trong bảng điều khiển của Cloudflare:
Bản ghi CNAME không thể cùng tồn tại với một bản ghi khác có cùng tên. Nếu bạn đã có bản ghi A, bản ghi AAAA, bản ghi TXT hoặc bất kỳ loại bản ghi nào khác cho tên miền phụ đã chọn, bạn cần xóa các bản ghi đó trước, trước khi thêm bản ghi CNAME.
Bạn có đang sử dụng Cloudflare không?
Nếu bạn đang cấu hình DNS trong bảng điều khiển của Cloudflare, vui lòng đảm bảo rằng tính năng proxy của Cloudflare (đám mây màu cam, còn được gọi là "Proxy status" trong cài đặt tên miền của bạn) được tắt. Điều này vì hai lý do:
Tùy chọn này che giấu DNS target của tên miền của bạn khỏi công chúng, khiến Apidog không thể thực hiện đúng các kiểm tra định kỳ trên tên miền tùy chỉnh của bạn.
Tên miền tùy chỉnh của bạn đã được hưởng lợi từ CDN.
Một lần nữa, vui lòng tắt Cloudflare proxying để đảm bảo tài liệu của bạn được phục vụ mà không gặp sự cố.

Mất bao lâu để các thay đổi có hiệu lực?#

Câu trả lời ngắn gọn: bạn có thể cần chờ từ 10 phút đến 48 giờ để các thay đổi DNS có hiệu lực trước khi chuyển sang bước tiếp theo.
Còn nhớ trường TTL (Time To Live) mà chúng tôi đã đề cập trước đó không? Các bản ghi DNS được lưu trong bộ nhớ đệm trong một khoảng thời gian — điều này thường rất tốt cho hiệu năng, vì chúng thường không thay đổi thường xuyên. Khi chúng có thay đổi, sẽ có một khoảng thời gian (giá trị TTL) mà các máy chủ bộ nhớ đệm DNS cần chờ bộ nhớ đệm hết hạn trước khi kiểm tra các thay đổi và hoạt động tương ứng.
Trong hầu hết trường hợp, tốt nhất là chờ ít nhất 10 phút trước khi chuyển sang bước tiếp theo và cuối cùng. Đôi khi mọi thứ có thể cập nhật nhanh hơn một chút, hoặc có thể mất lâu hơn. Hiếm khi quá trình này mất hơn 48 giờ.
Bạn muốn kiểm tra tiến trình của quy trình này, được gọi là propagation? Bạn có thể sử dụng công cụ tra cứu DNS, chẳng hạn như WhatsMyDNS. Nhập đầy đủ tên miền phụ của bạn, chọn CNAME từ danh sách thả xuống và nhấn nút Search. Các máy chủ bộ nhớ đệm DNS trên toàn thế giới sẽ phản hồi để cho bạn biết kết quả đã lưu trong bộ nhớ đệm của họ là gì. Bạn nên kiểm tra định kỳ các kết quả này cho đến khi phần lớn phản hồi bằng giá trị CNAME đã được gán cho bạn.

Cấu hình CDN hoặc máy chủ Reverse Proxy riêng của bạn#

Phạm vi áp dụng
Phần này chỉ áp dụng nếu bạn đã chọn tùy chọn Reverse Proxy ở bước trước.

Cấu hình AWS CloudFront#

Bạn có thể sử dụng dịch vụ CDN do các nhà cung cấp đám mây như AWS CloudFront, Cloudflare Enterprise cung cấp để thiết lập làm máy chủ reverse proxy của riêng bạn.
Trong ví dụ sau, chúng ta sẽ cấu hình AWS CloudFront làm Reverse Proxy.
1.
Đăng nhập vào AWS và điều hướng đến CloudFront. Nhấp vào Create Distribution.
2.
Cấu hình cài đặt distribution của bạn. Dưới đây là các giá trị bạn cần thay đổi.
Cài đặtGiá trị
Origin Domain NameĐặt thành {docsSiteId}.apidog.io
NameMô tả cho origin. Giá trị này giúp bạn phân biệt giữa nhiều origin trong cùng một distribution và do đó phải là duy nhất.
Origin Protocol PolicyĐặt thành chỉ HTTP
Alternate Domain Names (CNAMEs)Đặt thành tên miền tùy chỉnh của bạn (cùng tên miền bạn đã cấu hình trong cài đặt Publish trong quá trình thiết lập tên miền tùy chỉnh)
SSL CertificateĐặt thành SSL Certificate cho tên miền tùy chỉnh của bạn được lưu trữ trong AWS Certificate Manager (ACM).
3.
Cung cấp thông tin trong Origin Custom Headers (các trường Header Name và Value chỉ xuất hiện sau khi bạn đã cung cấp Origin Domain Name)
Header NameGiá trị
X-Apidog-Docs-Site-IDĐặt thành {docsSiteId}
{docsSiteId} là Docs Site ID của bạn, có thể tìm thấy trong bảng điều khiển tên miền tùy chỉnh. Vui lòng đảm bảo nhập đúng ID.
4.
Cấu hình Default Cache Behavior Settings. Dưới đây là các giá trị bạn cần thay đổi.
Cài đặtGiá trị
Viewer Protocol PolicyChọn Redirect HTTP to HTTPS
Allowed HTTP MethodsChọn GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE.
Cache and origin request settingsChọn Use legacy cache settings. Chọn All cho Headers, Query strings và Cookies
5.
Không bật AWS Web Application Firewall (WAF).
6.
Nhấp vào Create distribution ở cuối trang. Bạn sẽ thấy distribution mới tạo trong danh sách CloudFront Distributions. Lưu ý rằng Status sẽ hiển thị In progress cho đến khi distribution được Deployed.
7.
Thêm một bản ghi CNAME mới vào DNS của bạn cho tên miền tùy chỉnh, trỏ đến CloudFront Domain Name của Distribution. Bạn có thể tìm thấy thông tin này bằng cách nhấp vào Distribution ID của bạn, trong tab General, mục Distribution domain name (ví dụ: fd1fbc7cac6197.cloudfront.net).

Cấu hình Cloudflare làm Reverse Proxy#

Bạn có thể sử dụng Cloudflare Workers để hoạt động như một reverse proxy. Điều này cho phép bạn giữ tên miền ở trạng thái được proxy (Orange Cloud) trong khi vẫn đảm bảo Apidog nhận được các định danh dự án cần thiết.
1.
Đăng nhập vào Cloudflare Dashboard và điều hướng đến Workers & Pages.
2.
Nhấp vào Create Application, sau đó Create Worker. (Tiếp tục với Start with Hello World!, nếu được nhắc chọn phương thức)
3.
Đặt tên cho worker của bạn (ví dụ: apidog-docs-proxy) và nhấp vào Deploy.
4.
Nhấp vào Edit Code và thay thế script hiện có bằng nội dung sau:
Bạn có thể tìm thấy {docsSiteId} trong bảng điều khiển tên miền tùy chỉnh. Vui lòng đảm bảo nhập đúng ID vào cả hai biến targetHost và docsSiteId.
5.
Nhấp vào Save and Deploy.
6.
Điều hướng đến tab Settings của Worker, chọn Domains & Routes, rồi nhấp vào nút +Add.
7.
Nhập tên miền tùy chỉnh của bạn (ví dụ: docs.example.com). Cloudflare sẽ tự động xử lý các bản ghi DNS và chứng chỉ SSL.
8.
Đảm bảo SSL/TLS encryption mode của Cloudflare được đặt thành Full hoặc Full (Strict) để cho phép giao tiếp bảo mật giữa Cloudflare và Apidog.
Điều kiện tiên quyết
Trước khi gắn tên miền tùy chỉnh vào worker, hãy đảm bảo tên miền (ví dụ: example.com) đã được thêm vào tài khoản Cloudflare của bạn và nameserver của nó đang hoạt động.

Cấu hình máy chủ Reverse Proxy riêng của bạn#

Bạn có thể cấu hình máy chủ reverse proxy riêng cho tài liệu API của mình. Trong ví dụ sau, chúng ta sẽ sử dụng Nginx làm máy chủ reverse proxy.
1.
Thêm nội dung sau vào tệp cấu hình Nginx để cấu hình đơn giản.
Ví dụ cấu hình Caddy:
:8080 {
    handle_path /* {
        reverse_proxy http://{docsSiteId}.apidog.io {
            header_up X-Apidog-Docs-Site-ID {docsSiteId}
            header_up Host "docs.example.com"
        }
    }
}
{docsSiteId} là Docs Site ID của bạn, có thể tìm thấy trong bảng điều khiển tên miền tùy chỉnh. Vui lòng đảm bảo nhập đúng ID.
2.
Cấu hình bản ghi DNS cho tên miền tùy chỉnh của bạn để trỏ đến máy chủ reverse proxy.

Triển khai tài liệu API vào thư mục con của tên miền tùy chỉnh#

Reverse Proxy của Apidog cho phép tài liệu API được triển khai vào thư mục con của một tên miền tùy chỉnh. Ví dụ, bạn có thể triển khai tài liệu vào đường dẫn /api-docs trên một tên miền như https://example.com. Khi người dùng truy cập https://example.com/api-docs, họ sẽ truy cập tài liệu API trực tuyến do Apidog lưu trữ.

Các bước cấu hình:#

1.
Trên trang cài đặt Custom Domain của Apidog, nhập tên miền tùy chỉnh của bạn.
2.
Chọn Reverse Proxy và bật Use Subdirectory, sau đó nhập đường dẫn thư mục con.
3.
Tiếp theo, bạn cần sửa đổi tệp cấu hình của máy chủ web. Giả sử bạn đang sử dụng Nginx để proxy dịch vụ của mình, bạn có thể tham khảo cấu hình sau:
proxy_pass: Chuyển tiếp yêu cầu của client đến một máy chủ khác (chẳng hạn như máy chủ tài liệu API của Apidog).
proxy_set_header: Thiết lập các header yêu cầu do máy chủ proxy gửi đến máy chủ upstream, đảm bảo yêu cầu được xử lý đúng cách.
/api-docs/ là thư mục con của tên miền tùy chỉnh và phải kết thúc bằng / trong cấu hình Nginx.
http://{docsSiteId}.apidog.io/ cũng phải kết thúc bằng /.
Thay thế {docsSiteId} bằng ID trang tài liệu Apidog của bạn.
docs.example.com là một tên miền tùy chỉnh mẫu. Hãy thay thế bằng tên miền tùy chỉnh thực tế của bạn.
Sau khi cấu hình, bạn cần khởi động lại Nginx trên máy chủ của mình.

Bật HTTPS#

Tài liệu trực tuyến của Apidog hỗ trợ giao thức HTTPS, có một số ưu điểm so với HTTP:
Truyền dữ liệu an toàn: HTTPS sử dụng mã hóa SSL/TLS để đảm bảo an toàn cho quá trình truyền dữ liệu, ngăn bên thứ ba chặn thông tin.
Tối ưu hóa SEO: Trình thu thập dữ liệu của công cụ tìm kiếm ưu tiên sử dụng HTTPS vì giao thức này cung cấp bảo mật và bảo vệ quyền riêng tư tốt hơn. Do đó, các trang web HTTPS có thể có độ uy tín cao hơn trong xếp hạng công cụ tìm kiếm so với các trang web HTTP.

Các bước bật HTTPS:#

1.
Đi đến trang Publish và mở tab Custom Domain.
2.
Bật HTTPS để kích hoạt HTTPS, và tùy chọn, bạn có thể bật Always Use HTTPS để ngăn giao tiếp bị chiếm quyền hoặc các cuộc tấn công man-in-the-middle.

Quản lý chứng chỉ SSL#

Sau khi HTTPS được bật, bạn có thể chọn cách quản lý chứng chỉ SSL của mình:
Generated by Apidog: Apidog sẽ tự động tạo chứng chỉ SSL.
Use Your Own Certificate: Bạn có thể tải lên chứng chỉ SSL và khóa riêng do tổ chức chứng thực cấp (ví dụ: Let's Encrypt).

Khắc phục sự cố#

Nếu bạn gặp vấn đề khi thiết lập tên miền tùy chỉnh, vui lòng liên hệ với chúng tôi qua Discord.

Bạn có đang sử dụng Apidog Europe không?#

Nếu bạn đang sử dụng Apidog Europe, vui lòng đảm bảo rằng bạn đang sử dụng đúng tên miền cho quá trình thiết lập tên miền tùy chỉnh.
Tên miền đúng cho Apidog Europe trong thiết lập trước đây là {docsSiteId}.eu.apidog.com.
Modified at 2026-06-11 10:23:06
Previous
CSS, JavaScript, HTML tùy chỉnh
Next
Tính năng AI
Built with