Setelah berhasil mengirim permintaan API, Apidog dapat secara otomatis mengurai data permintaan dan respons untuk membuat spesifikasi endpoint yang lengkap. Fitur canggih ini menghemat waktu dan memastikan dokumentasi API Anda secara akurat mencerminkan perilaku di dunia nyata.Mengurai Permintaan menjadi Spesifikasi Endpoint#
Permintaan yang berhasil dikirim, jika belum didefinisikan, dapat secara otomatis diurai oleh Apidog menjadi spesifikasi endpoint.Setelah mengirim permintaan, Anda dapat mengklik dropdown di sebelah tombol Save dan memilih Save as endpoint untuk menyimpannya sebagai spesifikasi endpoint.Saat Anda menyimpan permintaan sebagai endpoint, Apidog secara cerdas mengekstrak informasi berikut:Parameter Permintaan: Jenis params permintaan dari permintaan saat ini akan diperlakukan sebagai spesifikasi parameter permintaan dalam endpoint, dan nilai parameter saat ini akan dianggap sebagai nilai contoh untuk parameter permintaan.
Skema Respons: Struktur data respons dari permintaan saat ini akan diurai sebagai spesifikasi respons, dan nilai respons akan diperlakukan sebagai contoh respons.
Fitur ini sangat berguna saat bekerja dengan API yang sudah ada atau ketika Anda ingin mendokumentasikan API dengan cepat berdasarkan data permintaan/respons aktual, alih-alih mendefinisikan skema secara manual.
Mengekstrak Respons#
Apidog mendukung ekstraksi respons ke dalam spesifikasi endpoint, yang dapat diekstrak sebagai skema respons atau contoh respons.Fleksibilitas ini memungkinkan Anda memilih apakah akan memperbarui definisi skema endpoint atau sekadar menambahkan contoh respons baru untuk keperluan dokumentasi dan pengujian.Mengekstrak respons sebagai skema berguna ketika struktur API telah berubah, sedangkan mengekstrak sebagai contoh lebih baik untuk mendokumentasikan berbagai skenario respons (berhasil, kesalahan, kasus batas).
