Setelah API Anda dikembangkan dan berhasil di-debug, Apidog memudahkan Anda untuk menghasilkan dokumentasi profesional yang dapat Anda bagikan dengan tim, pemangku kepentingan, atau pengembang eksternal.
Ikuti langkah-langkah berikut untuk menghasilkan dan membagikan dokumentasi API Anda:
Buka proyek Apidog Anda
Beralih ke modul Bagikan Dokumen dari sidebar
Lengkapi pengaturan berikut dalam konfigurasi berbagi:
| Pengaturan | Deskripsi | Tindakan yang Direkomendasikan |
|---|---|---|
| Nama | Berikan nama deskriptif untuk berbagi Anda | Gunakan nama proyek + versi (mis., "Pet Store API v1.2") |
| Lingkungan | Pilih lingkungan mana yang akan disertakan | Pilih semua lingkungan untuk dokumentasi yang komprehensif |
| Akses | Tetapkan izin visibilitas | Pilih tingkat akses yang sesuai untuk audiens Anda |
Dokumentasi Anda mencakup fitur-fitur canggih:
Penjelajah API Interaktif: Navigasikan endpoint dalam pohon direktori di sebelah kiri
Coba Langsung: Kirim permintaan langsung dari dokumentasi
Pembuatan Kode: Hasilkan cuplikan kode permintaan dan kode model data
Peralihan Lingkungan: Uji lingkungan API yang berbeda
Apidog menawarkan kustomisasi tambahan untuk dokumentasi Anda:
| Fitur | Deskripsi | Kasus Penggunaan |
|---|---|---|
| Tata Letak Kustom | Modifikasi struktur dan tampilan dokumentasi | Konsistensi merek, optimalisasi pengalaman pengguna |
| Domain Kustom | Gunakan nama domain Anda sendiri | Presentasi profesional, pengenalan merek |
| URL Kustom | Buat URL yang mudah diingat dan bermakna | Pemasaran, berbagi dengan mudah, manfaat SEO |
| Kontrol Akses | Tetapkan izin granular | Tim internal, mitra eksternal, akses publik |
INFO
Untuk informasi mendetail tentang opsi penerbitan lanjutan, lihat panduan Publikasikan dokumentasi API.