Gambaran Umum

Apidog menyediakan kemampuan publikasi yang andal yang mengubah spesifikasi API Anda menjadi dokumentasi profesional dan interaktif. Baik Anda perlu membagikan API secara internal dengan tim maupun menerbitkan dokumentasi komprehensif secara publik, Apidog menawarkan opsi fleksibel untuk memenuhi kebutuhan Anda—mulai dari tautan berbagi cepat hingga situs dokumentasi yang sepenuhnya disesuaikan dengan domain Anda sendiri.

Bagikan Dokumentasi API Anda

Apidog menawarkan berbagai cara untuk membagikan dan menerbitkan dokumentasi API Anda, masing-masing dirancang untuk kasus penggunaan yang berbeda:

Berbagi Cepat: Hasilkan dokumentasi API yang menarik dengan sekali klik dari spesifikasi API yang telah Anda tentukan, ideal untuk kolaborasi cepat

Dokumentasi Interaktif: Aktifkan fungsionalitas "Try it out" dan pembuatan kode online untuk eksplorasi API secara langsung

Situs Dokumentasi: Terbitkan situs dokumentasi komprehensif yang menggabungkan konten Markdown dengan dokumentasi API untuk panduan pengguna yang lengkap

Navigasi Kustom: Sesuaikan bilah navigasi dokumen Anda untuk meningkatkan pengalaman pengguna

Domain Kustom: Tautkan dokumentasi ke domain Anda sendiri untuk branding profesional

URL Kustom: Tentukan struktur URL halaman kustom

Kustomisasi Folder: Sesuaikan gaya folder dan perilaku klik dalam dokumentasi Anda

Publikasi Multi-Versi: Terbitkan dan kelola beberapa versi API secara bersamaan

Contoh Dokumentasi

Lihat contoh nyata dokumentasi yang telah diterbitkan: https://docs.salla.dev/

Teknologi API yang Didukung

Apidog menyediakan dukungan komprehensif untuk mendokumentasikan hampir semua teknologi API. Baik Anda bekerja dengan API REST tradisional, GraphQL modern, koneksi WebSocket real-time, maupun layanan SOAP perusahaan, Apidog siap mendukung Anda.

Teknologi yang didukung mencakup: REST, SOAP, GraphQL, gRPC, WebSocket, SSE, dan lainnya.

Jelajahi kumpulan praktik terbaik dokumentasi dan contoh API nyata kami untuk melihat bagaimana berbagai jenis API dapat didokumentasikan secara efektif.

Pelajari Lebih Lanjut

Temukan panduan dan contoh terperinci untuk setiap teknologi API di Teknologi API yang Didukung.

Berbagi Cepat vs Terbitkan Dokumentasi

Apidog menawarkan dua metode publikasi yang berbeda, masing-masing dioptimalkan untuk skenario yang berbeda. Memahami perbedaannya akan membantu Anda memilih pendekatan yang tepat sesuai kebutuhan Anda.

Berbagi Cepat dirancang untuk kolaborasi yang cepat dan fleksibel—ideal untuk membagikan API tertentu kepada anggota tim atau mitra eksternal selama pengembangan. Terbitkan Dokumentasi dibuat untuk membuat situs dokumentasi profesional yang ditujukan untuk publik dengan kemampuan kustomisasi penuh.

Perbandingan Fitur

Fitur	Berbagi Cepat	Terbitkan Dokumentasi
Terbitkan sebagian API	✓ Didukung	Hanya seluruh proyek
Domain kustom	✗ Tidak didukung	✓ Didukung
Navigasi kustom	✗ Tidak didukung	✓ Didukung
Warna dan logo kustom	✗ Tidak didukung	✓ Didukung
Terbitkan ke API Hub	✗ Tidak didukung	✓ Didukung

Rekomendasi

Gunakan Berbagi Cepat untuk kolaborasi internal dan tinjauan API cepat. Gunakan Terbitkan Dokumentasi ketika Anda memerlukan situs dokumentasi profesional dengan branding khusus untuk konsumsi publik.

Bagikan Dokumentasi API Anda#

Teknologi API yang Didukung#

Berbagi Cepat vs Terbitkan Dokumentasi#

Perbandingan Fitur#

Bagikan Dokumentasi API Anda

Teknologi API yang Didukung

Berbagi Cepat vs Terbitkan Dokumentasi

Perbandingan Fitur