Pengujian Kontrak

Pengujian Kontrak digunakan untuk memvalidasi apakah respons API aktual sesuai dengan spesifikasi yang ditetapkan dalam dokumentasi API (OpenAPI). Dengan melakukan pemeriksaan konsistensi pada konten seperti kode status dan struktur respons, fitur ini memungkinkan penemuan ketidaksesuaian secara tepat waktu antara implementasi dan dokumentasi selama fase pengembangan, debugging, dan pengujian, sehingga memastikan perilaku API yang stabil dan andal antar layanan.

Kapabilitas Validasi Respons (Pengujian Kontrak) Apidog terintegrasi secara mendalam dengan dokumentasi API. Fitur ini dapat digunakan selama Permintaan API, dalam Kasus Debug, Kasus Pengujian, dan Langkah Pengujian Otomatis. Ini adalah fitur dasar yang diaktifkan secara default.

Mengaktifkan Validasi Respons

Validasi Respons dapat diaktifkan berdasarkan modul dan digunakan pada berbagai tahap sesuai kebutuhan bisnis. Tombol alih yang relevan berada di "Settings -> Response Validation Settings".

Permintaan API dan Kasus Debug

Saat diaktifkan, fitur "Validate Response" tersedia dalam tampilan "Request" dan "Debug Case" di dalam modul APIs, yang digunakan untuk memverifikasi konsistensi respons selama fase debugging.

Kasus Pengujian

Saat diaktifkan, "Validate Response" dapat dijalankan dalam "Test Cases" di dalam modul APIs untuk memverifikasi perilaku API selama pengujian manual.

Langkah Pengujian Otomatis

Saat diaktifkan, "Validate Response" dapat ditambahkan sebagai Langkah Pengujian dalam modul Tests, dengan memasukkan Validasi Respons ke dalam alur kerja pengujian otomatis yang lengkap.

Memvalidasi Konten Respons

Validasi Respons Apidog akan secara otomatis melakukan pemeriksaan berikut berdasarkan spesifikasi OpenAPI yang ditetapkan dalam dokumentasi API:

Memvalidasi Kode Status HTTP Respons

Memeriksa apakah kode status HTTP dari respons aktual konsisten dengan kode status yang ditetapkan dalam dokumentasi. Misalnya:

Dokumentasi menetapkan 200, tetapi hasil aktual yang dikembalikan adalah 204

Dokumentasi menetapkan beberapa nilai yang mungkin (misalnya, 200, 201, 400, 403), dengan memvalidasi terhadap rentang yang diizinkan

Jika tidak konsisten, kegagalan validasi akan dilaporkan.

Memvalidasi Skema Body Respons

Memvalidasi konten berikut berdasarkan Skema Data yang ditetapkan dalam dokumentasi:

Apakah suatu field wajib diisi

Apakah nilai suatu field adalah null

Apakah tipe field sudah benar

Apakah field wajib tersedia

Apakah struktur Array dan Object sesuai dengan dokumentasi

Apakah nilai enum valid

...

Ini adalah kapabilitas validasi inti dari Validasi Respons.

Kontrol Properti Tambahan dalam Object

Untuk field bertipe Object:

Jika additionalProperties tidak diatur dalam dokumentasi, Anda dapat memilih apakah respons aktual diizinkan berisi field tambahan yang tidak ditetapkan dalam dokumentasi.

Jika additionalProperties diatur, fitur ini memvalidasi izin atas field tambahan sesuai dengan aturan dalam dokumentasi.

Kapabilitas ini memungkinkan kontrol yang fleksibel atau ketat atas struktur respons agar dapat menyesuaikan dengan persyaratan batasan API dari berbagai tim.

Mengaktifkan Validasi Respons#

Permintaan API dan Kasus Debug#

Kasus Pengujian#

Langkah Pengujian Otomatis#

Memvalidasi Konten Respons#

Memvalidasi Kode Status HTTP Respons#

Memvalidasi Skema Body Respons#

Kontrol Properti Tambahan dalam Object#