Menerbitkan Situs Dokumentasi

Menerbitkan situs dokumentasi membuat rumah permanen yang sepenuhnya dapat disesuaikan untuk dokumentasi API Anda—berbeda dari fitur Quick Share, yang dirancang untuk kolaborasi sementara. Sementara Quick Share menghasilkan tautan yang dapat dibagikan untuk komunikasi internal dan eksternal secara cepat, Publish Docs Sites menyediakan opsi penyesuaian yang komprehensif, termasuk domain kustom, desain bermerek, kontrol navigasi, dan fitur lanjutan. Hal ini menjadikannya ideal untuk membuat dokumentasi API profesional yang ditujukan untuk publik dan merepresentasikan merek Anda.

Prasyarat

Sebelum menerbitkan situs dokumentasi, pastikan Anda memiliki:

Akun Apidog dengan proyek yang berisi dokumentasi API

Izin Admin untuk proyek tersebut

(Opsional) Domain kustom jika Anda berencana menggunakan URL bermerek

Konfigurasi Awal

Menerbitkan Situs Dokumentasi Anda

Untuk menerbitkan situs dokumentasi Anda, buka modul Publish Docs dan klik situs utama default, lalu klik tombol Publish.

Pengaturan Visibilitas Situs Dokumentasi

Persyaratan Versi

Versi Apidog harus ≥ 2.7.15 untuk mengakses fitur visibilitas ini.

Setelah mengklik tombol Publish, Anda dapat mengontrol visibilitas situs dokumentasi yang diterbitkan berdasarkan kebutuhan keamanan dan akses Anda. Klik tombol Publish right now untuk membuat situs Anda aktif dengan pengaturan visibilitas yang Anda pilih.

Publik

Situs dokumentasi Anda akan dapat diakses oleh semua pengguna internet. Anda juga dapat memilih untuk menerbitkan dokumentasi API Anda di API Hub, sebuah platform yang dioperasikan oleh Apidog yang membantu pengguna menemukan dan menjelajahi API.

Dilindungi kata sandi

Daftar IP yang Diizinkan

Daftar Email yang Diizinkan

Halaman Login Kustom

Cakupan Penerbitan

Secara default, cakupan untuk menerbitkan dokumentasi ditetapkan ke semua sumber daya Shared. Anda dapat mengonfigurasikannya di APIs. Untuk detail selengkapnya, silakan lihat pengaturan visibilitas.

Konfigurasi Lanjutan

Try It

Anda dapat mengaktifkan fitur Try It untuk halaman dokumentasi Anda, sehingga pengguna dapat langsung membuat permintaan API pada halaman dokumentasi itu sendiri.

Versi Rilis

Anda dapat membuat dan menerbitkan beberapa versi dokumentasi API Anda. Pelajari lebih lanjut tentang menerbitkan versi API.

pengaturan rilis untuk Dokumentasi API.jpg

Sumber Daya Terkait

Bagaimana Pengguna Dokumentasi Dapat Mengubah Base URL di Dokumentasi Bersama?

Bagaimana Cara Membagikan Header (misalnya, Token) di Dokumentasi Online Apidog?

Pengaturan Domain

Domain yang disediakan Apidog: Dokumen Anda akan memiliki Subdomain Apidog default, seperti https://vhh2uhkjv7.apidog.io. Anda juga dapat mengubahnya secara manual. Semua dokumen Apidog menggunakan domain apidog.io.

Domain Kustom: Anda dapat mengikat dokumen Apidog ke domain Anda sendiri. Pelajari lebih lanjut tentang Domain kustom.

pengaturan domain untuk dokumentasi API.jpg

Penyesuaian Visual

Anda dapat menyesuaikan tampilan dan tata letak untuk dokumentasi API.

Anda dapat mempratinjau dokumen Anda secara real time di sini dan menyimpannya setelah Anda puas dengan hasilnya.

Tampilan

Tata Letak & Navigasi

Halaman Arahan Kustom

CSS, JavaScript, dan HTML Kustom

Di bawah Pengaturan Tampilan, Anda dapat mengonfigurasi berbagai opsi dasar untuk dokumentasi API Anda, termasuk Title, Logo, dan Favicon.

Di bawah Display content, Anda dapat menyesuaikan bidang mana yang akan ditampilkan dalam dokumentasi API, termasuk: Base URL, Maintainer, dan Last Modified Time.

Pengaturan SEO

Pengaturan	Deskripsi
Metadata Global	Mengonfigurasi metadata default untuk seluruh situs.
File Robots	File `robots.txt` menginstruksikan mesin pencari tentang halaman mana yang akan dirayapi dan ditampilkan dalam hasil pencarian.
File Sitemap	File `sitemap.xml` menyediakan daftar komprehensif semua halaman di situs Anda kepada mesin pencari untuk pengindeksan yang lebih baik.
Aturan Pengalihan Dokumentasi	Mengalihkan pengguna ke halaman dokumentasi yang benar ketika URL berubah, sehingga mencegah tautan rusak.
Aturan URL & Slug	Menentukan struktur URL dan format slug untuk halaman dokumentasi Anda.

Pengaturan Lanjutan

Fitur	Deskripsi
Pencarian Dokumentasi	Terintegrasi dengan Algolia untuk menyediakan kemampuan pencarian yang ditingkatkan bagi dokumentasi API Anda yang diterbitkan. Fitur Ask AI membuka tanya jawab percakapan yang didukung AI langsung di dalam pencarian dokumentasi Anda.
CORS Proxy	Menentukan CORS proxy untuk mencegah masalah lintas asal yang dapat timbul dari pembatasan keamanan browser.
Google Analytics	Mengaktifkan integrasi dengan Google Analytics untuk melacak dan menganalisis lalu lintas ke situs dokumentasi Anda.
Terbitkan ke API Hub	Menerbitkan dokumentasi Anda ke API Hub, sebuah platform terbuka untuk berbagi dan menemukan API.
Deskripsi	Menetapkan deskripsi yang akan ditampilkan di API Hub jika proyek diterbitkan di sana.
Izinkan Data 'Export', 'Clone'	Mengizinkan pengguna mengekspor atau mengkloning data dokumentasi dari cabang utama.

Menerbitkan Beberapa Situs Dokumentasi

Untuk menerbitkan dokumentasi di berbagai saluran dalam proyek yang sama, Anda dapat membuat situs dokumentasi tambahan selama penerbitan. Untuk pengelolaan yang lebih mudah, Anda dapat menduplikasi konfigurasi situs utama untuk setiap situs baru. Setiap sub-situs juga dapat memiliki nama domain kustom yang unik.

Hanya subsitus yang memungkinkan Anda menetapkan cakupan visibilitas untuk dokumentasi yang diterbitkan, sehingga Anda dapat memilih sumber daya mana yang dapat diakses secara publik.

Menerbitkan Situs Dokumentasi

Prasyarat#

Konfigurasi Awal#

Menerbitkan Situs Dokumentasi Anda#

Pengaturan Visibilitas Situs Dokumentasi#

Cakupan Penerbitan#

Konfigurasi Lanjutan#

Try It#

Versi Rilis#

Pengaturan Domain#

Penyesuaian Visual#

Pengaturan SEO#

Pengaturan Lanjutan#

Menerbitkan Beberapa Situs Dokumentasi#

Prasyarat

Konfigurasi Awal

Menerbitkan Situs Dokumentasi Anda

Pengaturan Visibilitas Situs Dokumentasi

Cakupan Penerbitan

Konfigurasi Lanjutan

Try It

Versi Rilis

Pengaturan Domain

Penyesuaian Visual

Pengaturan SEO

Pengaturan Lanjutan

Menerbitkan Beberapa Situs Dokumentasi