Dokumentasi API yang dipublikasikan oleh Apidog menyediakan tampilan API Anda yang interaktif dan komprehensif. Ketika pengguna mengakses URL dokumentasi Anda, mereka akan melihat penyajian yang terstruktur dengan baik untuk setiap endpoint, dengan beberapa bagian yang dirancang agar mudah dipahami dan diuji.
Bagian ini menampilkan informasi penting endpoint seperti URL, metode HTTP, waktu modifikasi, dan deskripsi. Anda dapat memilih kolom mana yang akan ditampilkan saat membuat dokumentasi.
Endpoint dengan status "Released" tidak akan menampilkan tag status. Endpoint dengan status lain, seperti "Developing", akan menampilkan tag status setelah nama endpoint. Endpoint dengan status "Deprecated" ditampilkan sebagai "nama endpoint" pada pohon direktori di sebelah kiri.
Klik "Try it out" untuk memperluas lapisan pengujian interaktif, tempat Anda dapat mengirim permintaan, mengubah parameter, dan beralih lingkungan. Lingkungan yang tersedia adalah lingkungan yang dipilih saat membuat dokumentasi.
Cloud Mock Environment
Jika Anda memilih lingkungan Cloud mock saat membuat dokumentasi, Anda menyediakan lingkungan sandbox sederhana bagi pembaca untuk menguji API.
Setelah mengirim permintaan, Anda dapat melihat respons dan permintaan aktual pada halaman tersebut.
Anda dapat mengonfigurasi autentikasi pada tingkat API atau folder dalam pengaturan Auth proyek Anda. Gunakan security schemes atau tentukan pengaturan secara manual.
Setelah mengonfigurasi pengaturan autentikasi—misalnya, menggunakan autentikasi Bearer Token—Anda akan melihat bagian "Credentials" di bagian atas panel "Publish Documentation", tempat Anda dapat langsung memasukkan nilai token.
Manfaat utama dari pendekatan konfigurasi ini adalah informasi autentikasi dapat dibagikan di berbagai API. Jika beberapa API merujuk pada security scheme atau jenis autentikasi yang sama, Anda hanya perlu memasukkan informasi autentikasi satu kali, dan API lainnya dapat menggunakannya kembali secara otomatis.
Kredensial ini dienkripsi dan disimpan di LocalStorage browser, serta dikelola berdasarkan sesi browser. Dalam sesi yang sama, kredensial tersebut dapat dibagikan di beberapa jendela dan tab. Setelah browser ditutup dan sesi berakhir, kredensial ini secara otomatis menjadi tidak valid.Secara lebih spesifik: kredensial yang disimpan di LocalStorage dienkripsi, sedangkan kunci dekripsi disimpan dalam cookie sesi. Meskipun data di LocalStorage tetap tersimpan dalam jangka panjang, kunci dekripsi dalam cookie sesi akan kedaluwarsa segera setelah browser ditutup. Akibatnya, data terenkripsi tidak lagi dapat didekripsi atau diakses, dan Anda perlu memasukkan kembali kredensial saat mengunjungi berikutnya.
Bagian ini menampilkan spesifikasi parameter dan body. Apidog mendukung dua gaya tampilan parameter—Modern atau Classic—yang dapat Anda pilih di Settings → Feature Settings → Endpoint Feature Settings.
Jika Anda memilih "Allow exporting data" saat membuat dokumentasi, pembaca akan melihat opsi Export di sudut kanan bawah dan di bagian paling bawah dokumen.
Pembaca dapat memilih antara "Clone" atau "Export". "Export" mendukung ekspor dalam format OAS, HTML, Markdown, dan Apidog.
