Secara default, dokumentasi Anda dapat diakses pada domain [subdomain].apidog.io. Namun, Anda dapat menyesuaikannya dengan menetapkan domain khusus, sehingga audiens Anda dapat mengakses dokumentasi pada domain yang sesuai dengan organisasi Anda.Domain khusus dapat ditetapkan oleh pengguna dengan izin admin. Ikuti langkah-langkah berikut untuk menetapkan domain khusus.Memulai pengaturan domain khusus#
Anda dapat mengakses opsi untuk menetapkan domain khusus bagi sebuah proyek di modul Share proyek tersebut. Cukup klik menu Share Docs di sidebar, lalu buka halaman pengaturan Publish pada menu sekunder.Anda akan melihat bagian berjudul Custom Domain. Klik tombol Edit untuk memulai pengaturan domain khusus.Ada dua jenis opsi untuk menetapkan domain khusus:1.
CNAME: Ini adalah opsi yang direkomendasikan. Opsi ini paling mudah disiapkan dan dipelihara. Opsi ini juga merupakan opsi yang paling fleksibel, karena memungkinkan Anda menetapkan domain khusus untuk subdomain atau domain root.
2.
Reverse Proxy: Opsi ini lebih tingkat lanjut dan mengharuskan Anda menggunakan Content Delivery Network (CDN) atau menyiapkan reverse proxy pada server Anda sendiri. Opsi ini direkomendasikan untuk pengguna yang familier dengan teknologi tersebut.
Mengonfigurasi CNAME#
Ini hanya berlaku jika Anda telah memilih opsi CNAME pada langkah sebelumnya.
1.
Mengonfigurasi catatan CNAME
2.
Menunggu perubahan berlaku
Mengonfigurasi catatan CNAME#
Nama bidang dan apa yang sebenarnya perlu dimasukkan untuk mengonfigurasi catatan dapat berbeda antar panel kontrol DNS, tetapi kami telah mencakup opsi yang paling umum di sini. Jika Anda tidak yakin, verifikasikan dengan penyedia DNS Anda.type adalah jenis catatan DNS yang ingin Anda buat. Di sini, Anda perlu memilih CNAME.
name atau DNS entry adalah tempat Anda memasukkan subdomain Anda. Anda mungkin perlu memasukkannya secara lengkap (misalnya docs.example.com) atau Anda mungkin hanya perlu memasukkan bagian sebelum domain apex Anda (misalnya docs). Jika Anda tidak yakin mana yang harus digunakan, periksa dengan penyedia DNS Anda.
target atau value atau destination adalah tujuan subdomain harus diarahkan. Anda akan melihat nilai ini di pengaturan Publish di Apidog saat memilih opsi DNS CNAME. Nilainya akan terlihat seperti {projectId}.apidog.io. Anda harus memasukkan nilai ini secara lengkap (misalnya 12345678.apidog.io).
Anda mungkin juga melihat bidang bernama TTL, yang merupakan singkatan dari Time To Live. Ini adalah jumlah detik selama catatan DNS dapat di-cache. Jika Anda tidak yakin apa yang harus ditetapkan, kami menyarankan untuk memilih Auto atau tetap menggunakan nilai default.
Apakah Anda menggunakan Cloudflare?#
Jika Anda mengonfigurasi DNS di panel kontrol Cloudflare, pastikan proxy Cloudflare (awan oranye, juga disebut "Proxy status" dalam pengaturan domain Anda) dinonaktifkan. Ini karena dua alasan:Opsi ini menyamarkan target DNS untuk domain Anda dari publik, sehingga mencegah Apidog menjalankan pemeriksaan rutin dengan benar pada domain khusus Anda.
Domain khusus Anda sudah akan memperoleh manfaat dari CDN.
10 minutes ~ 48 hours agar perubahan DNS berlaku sebelum melanjutkan ke langkah berikutnya.Ingat bidang TTL (Time To Live) yang kami sebutkan sebelumnya? Catatan DNS di-cache selama periode waktu tertentu — yang biasanya sangat baik untuk alasan performa, karena catatan tersebut umumnya tidak sering berubah. Ketika catatan tersebut memang berubah, ada periode waktu (nilai TTL) di mana server cache DNS perlu menunggu cache mereka kedaluwarsa sebelum memeriksa perubahan dan bertindak sesuai dengannya.Dalam sebagian besar kasus, sebaiknya tunggu setidaknya 10 menit sebelum melanjutkan ke langkah berikutnya dan terakhir. Terkadang semuanya dapat diperbarui sedikit lebih cepat, atau dapat memerlukan waktu lebih lama. Jarang sekali proses ini memerlukan waktu lebih dari 48 jam.Ingin memeriksa bagaimana proses ini, yang dikenal sebagai propagation, berlangsung? Anda dapat menggunakan alat pencarian DNS, seperti WhatsMyDNS. Masukkan subdomain lengkap Anda, pilih CNAME dari daftar dropdown, lalu tekan tombol Search. Server cache DNS di seluruh dunia akan merespons untuk memberi tahu Anda hasil cache mereka. Anda perlu memeriksa hasil ini secara berkala hingga sebagian besar merespons dengan nilai CNAME yang telah ditetapkan untuk Anda.Mengonfigurasi CDN atau Server Reverse Proxy Anda Sendiri#
Ini hanya berlaku jika Anda telah memilih opsi Reverse Proxy pada langkah sebelumnya.
Mengonfigurasi AWS CloudFront sebagai reverse proxy#
Anda dapat memanfaatkan layanan CDN yang disediakan oleh vendor cloud seperti AWS CloudFront, Cloudflare Enterprise untuk menyiapkannya sebagai server reverse proxy Anda sendiri.Dalam contoh berikut, kami akan mengonfigurasi AWS CloudFront sebagai Reverse Proxy.1.
Masuk ke AWS, lalu buka CloudFront. Klik Create Distribution. 2.
Konfigurasikan pengaturan distribusi Anda. Berikut adalah nilai yang perlu Anda ubah.
| Pengaturan | Nilai |
|---|
| Origin Domain Name | Atur ke {projectId}.apidog.io |
| Name | Deskripsi untuk origin. Nilai ini memungkinkan Anda membedakan beberapa origin dalam distribusi yang sama dan oleh karena itu harus unik. |
| Origin Protocol Policy | Atur ke HTTP Only |
| Alternate Domain Names (CNAMEs) | Atur ke nama domain khusus Anda (yang sama dengan yang Anda konfigurasi di pengaturan Publish selama pengaturan domain khusus) |
| SSL Certificate | Atur ke SSL Certificate untuk domain khusus Anda yang disimpan di AWS Certificate Manager (ACM). |
3.
Berikan informasi pada Origin Custom Headers (bidang Header Name dan Value hanya muncul setelah Anda memberikan Origin Domain Name)
| Header Name | Nilai |
|---|
| X-Apidog-Project-ID | Atur ke {projectId} |
Anda dapat menemukan nilai projectId di pengaturan proyek Apidog.
4.
Konfigurasikan Default Cache Behavior Settings. Berikut adalah nilai yang perlu Anda ubah.
| Pengaturan | Nilai |
|---|
| Viewer Protocol Policy | Pilih Redirect HTTP to HTTPS |
| Allowed HTTP Methods | Pilih GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE. |
| Cache and origin request settings | Pilih Use legacy cache settings. Pilih All untuk Headers, Query strings, dan Cookies |
5.
Jangan aktifkan AWS Web Application Firewall (WAF).
6.
Klik Create distribution di bagian bawah halaman. Anda akan melihat distribusi yang baru dibuat dalam daftar CloudFront Distributions Anda. Perhatikan bahwa Status akan menampilkan In progress hingga distribusi berstatus Deployed.
7.
Tambahkan catatan CNAME baru ke DNS Anda untuk domain khusus Anda yang mengarah ke CloudFront Domain Name untuk Distribution Anda. Ini dapat ditemukan dengan mengklik Distribution ID Anda, pada tab General, Distribution domain name (misalnya, fd1fbc7cac6197.cloudfront.net).
Mengonfigurasi server reverse proxy Anda sendiri#
Anda dapat mengonfigurasi server reverse proxy Anda sendiri untuk dokumentasi API Anda. Dalam contoh berikut, kami akan menggunakan Nginx sebagai server reverse proxy.1.
Tambahkan konten berikut ke file konfigurasi Nginx untuk konfigurasi sederhana.
:8080 {
handle_path /* {
reverse_proxy http://{projectId.apidog.io {
header_up X-Apidog-Project-ID {projectId}
header_up Host "docs.example.com"
}
}
}
}
Anda dapat menemukan nilai {projectId} di pengaturan proyek Apidog.
2.
Konfigurasikan catatan DNS untuk nama domain khusus Anda agar mengarah ke server reverse proxy Anda.
Men-deploy Dokumen API ke Subdirektori Domain Khusus#
Reverse Proxy Apidog memungkinkan dokumen API di-deploy ke subdirektori domain khusus. Misalnya, Anda dapat men-deploy dokumentasi ke path /api-docs pada domain seperti https://example.com. Ketika pengguna mengunjungi https://example.com/api-docs, mereka akan mengakses dokumentasi API online yang dihosting oleh Apidog.Langkah-langkah Konfigurasi:#
1.
Pada halaman pengaturan Custom Domain Apidog, masukkan domain khusus Anda.
2.
Pilih Reverse Proxy dan aktifkan Use Subdirectory, lalu masukkan path subdirektori.
3.
Selanjutnya, Anda perlu memodifikasi file konfigurasi server web Anda. Dengan asumsi Anda menggunakan Nginx untuk mem-proxy layanan Anda, Anda dapat merujuk pada konfigurasi berikut:
proxy_pass: Meneruskan permintaan klien ke server lain (seperti server dokumentasi API Apidog).
proxy_set_header: Menetapkan header permintaan yang dikirim oleh server proxy ke server upstream, memastikan permintaan ditangani dengan benar.
/api-docs/ adalah subdirektori domain khusus, dan harus diakhiri dengan / dalam konfigurasi Nginx.
http://{projectId}.apidog.io/ juga harus diakhiri dengan /.
Ganti {projectId} dengan ID proyek Apidog Anda.
docs.example.com adalah contoh domain khusus. Ganti dengan domain khusus Anda yang sebenarnya.
Setelah konfigurasi, Anda perlu memulai ulang Nginx pada server Anda.
Mengaktifkan HTTPS#
Dokumentasi online Apidog mendukung protokol HTTPS, yang memiliki beberapa keunggulan dibandingkan HTTP:Transmisi data yang aman: HTTPS menggunakan enkripsi SSL/TLS untuk memastikan keamanan transmisi data, mencegah pihak ketiga menyadap informasi.
Optimisasi SEO: Perayap mesin pencari lebih memilih menggunakan HTTPS karena menawarkan keamanan dan perlindungan privasi yang lebih baik. Oleh karena itu, situs web HTTPS dapat memiliki otoritas yang lebih tinggi dalam peringkat mesin pencari dibandingkan situs web HTTP.
Langkah-langkah untuk Mengaktifkan HTTPS:#
1.
Buka halaman Publish dan buka tab Custom Domain.
2.
Aktifkan HTTPS untuk mengaktifkan HTTPS, dan secara opsional, Anda dapat mengaktifkan Always Use HTTPS untuk mencegah komunikasi dibajak atau serangan man-in-the-middle.
Manajemen Sertifikat SSL#
Setelah HTTPS diaktifkan, Anda dapat memilih cara mengelola sertifikat SSL Anda:Generated by Apidog: Apidog akan secara otomatis menghasilkan sertifikat SSL.
Use Your Own Certificate: Anda dapat mengunggah sertifikat SSL dan kunci privat yang diterbitkan oleh otoritas sertifikat (misalnya, Let's Encrypt). Pemecahan Masalah#
Jika Anda mengalami masalah saat menyiapkan domain khusus Anda, silakan hubungi kami melalui Discord.Apakah Anda menggunakan Apidog Europe?#
Jika Anda menggunakan Apidog Europe, pastikan bahwa Anda menggunakan domain yang benar untuk pengaturan domain khusus Anda.Domain yang benar untuk Apidog Europe pada pengaturan sebelumnya adalah {projectId}.eu.apidog.com. 
