Komponen

Umumnya dalam desain API, meskipun respons sukses 200 OK sering kali berbeda di berbagai endpoint karena kebutuhan data keluaran yang berbeda, respons kesalahan seperti 400 Bad Request dan 404 Not Found cenderung konsisten di berbagai endpoint.

Apidog secara cerdas menangani kesamaan umum ini dengan fitur Komponen Respons, yang memungkinkan penggunaan kembali respons kesalahan yang telah ditentukan sebelumnya, sehingga membuat proses dokumentasi API lebih efisien dan perilaku API lebih konsisten.

Kompatibilitas OAS

Fitur Komponen Respons di Apidog kompatibel dengan Komponen dalam OAS.

Menambahkan Komponen Respons

Di pohon direktori kiri pada modul APIs, buka bagian Komponen, lalu klik Respons Baru di bawah Respons untuk membuat komponen respons baru.

Membuat komponen respons serupa dengan menentukan bagian respons saat mendefinisikan endpoint, dalam hal menyertakan kode status HTTP, Jenis konten, Skema, dan Contoh. Untuk panduan terperinci, lihat bagian Respons dalam Dasar-Dasar Endpoint.

Fitur Unik Komponen Respons

Ditambahkan secara default di endpoint baru: Ketika dipilih sebagai "Ya", komponen ini akan secara otomatis disertakan secara default di semua endpoint baru yang ditambahkan ke proyek.

INFO

Endpoint yang sudah ada tidak terpengaruh oleh pengaturan ini.

Mereferensikan Komponen Respons

Di bagian Respons pada sebuah endpoint, Anda dapat mereferensikan komponen respons yang telah ditentukan sebelumnya.

Poin-poin penting tentang komponen yang direferensikan:

Komponen respons yang direferensikan tidak dapat dimodifikasi di dalam endpoint. Anda harus melakukan perubahan pada komponen respons asli. Setiap modifikasi yang dilakukan akan berdampak pada semua endpoint yang mereferensikan komponen ini.

Jika Anda ingin memodifikasi komponen respons yang telah direferensikan dalam sebuah endpoint, Anda dapat melakukan Dereference. Dereference akan mengubah respons menjadi respons reguler yang dapat diedit, dan perubahan pada komponen respons tidak lagi akan memengaruhinya.

Dalam sebuah endpoint, satu komponen hanya dapat direferensikan satu kali; beberapa instans dari komponen yang sama tidak dapat berdampingan dalam endpoint yang sama.

Operasi Batch

Anda dapat secara massal Menambahkan komponen respons yang ada ke endpoint yang dipilih, atau secara massal Menghapus komponen ini dari endpoint yang dipilih.

Catatan:

Jika endpoint yang dipilih sudah menyertakan komponen respons ini, komponen tersebut tidak akan ditambahkan lagi.

Jika endpoint yang dipilih tidak berisi komponen respons ini, tindakan hapus tidak akan berpengaruh.

Templat Respons Default

Banyak perusahaan memiliki struktur standar untuk respons mereka. Dalam kasus seperti itu, Anda dapat memanfaatkan Templat Respons Default untuk mempertahankan struktur tetap perusahaan sebagai templat respons default.

Di pohon direktori kiri di bawah bagian Komponen, Anda dapat mengakses dan menggunakan fitur Templat Respons Default.

Ketika endpoint baru dibuat, konten templat ini digunakan sebagai respons awal.

Karakteristik utama:

Perubahan yang dilakukan pada templat respons default hanya akan berdampak pada endpoint baru, dan endpoint yang sudah ada tidak akan terpengaruh.

Hanya ada satu templat respons default, yang tidak dapat ditambahkan atau dihapus.

Templat respons default awal adalah Respons Sukses 200 dengan Jenis konten JSON dan struktur data berupa node Objek kosong.

FAQ

T: Dapatkah saya menggunakan komponen respons sebagai respons default?

J: Tidak, komponen respons ditujukan untuk respons kesalahan generik seperti 400, 404, dan kode status serupa. Jika Anda perlu menggunakan respons default yang tetap, silakan gunakan templat respons default.

Menambahkan Komponen Respons#

Fitur Unik Komponen Respons#

Mereferensikan Komponen Respons#

Operasi Batch#

Templat Respons Default#

FAQ#

Menambahkan Komponen Respons

Fitur Unik Komponen Respons

Mereferensikan Komponen Respons

Operasi Batch

Templat Respons Default

FAQ