ToolRobinTanpa login, langsung pakai

Pemeriksa Kompatibilitas OpenAPI

Bandingkan dua spesifikasi OpenAPI 3.x secara lokal dan tinjau perubahan kontrak API yang berpotensi melanggar berdasarkan operasi dan jalur lapangan.

Tempel atau pilih file OpenAPI 3.0, 3.1, atau 3.2 asli dan revisi. Periksa tingkat keparahan dan jalur bidang yang terpengaruh, lalu unduh laporan Penurunan Harga atau JSON untuk ditinjau.

Bandingkan dua file OpenAPI sebelum rilis. Spesifikasinya tetap di browser ini.

Tempelkan JSON atau YAML di bawah, atau pilih file.
Tempelkan JSON atau YAML di bawah, atau pilih file.

Setiap file: hingga 2 MB dan 1.000 operasi. Mendukung OpenAPI 3.0, 3.1 dan 3.2.

Cara menggunakan

Tinjau perubahan OpenAPI sebelum merilis API

Bandingkan dua spesifikasi OpenAPI 3.x secara lokal dan tinjau perubahan kontrak API yang berpotensi melanggar berdasarkan operasi dan jalur lapangan.

Langkah penggunaan

  1. Masukkan sumber melalui: Spesifikasi asli / Spesifikasi yang direvisi.
  2. Jalankan: Periksa kompatibilitas. Periksa hasil sebelum menyalin, mengunduh, atau menggunakannya di tempat lain.
  3. Tempel atau pilih file OpenAPI 3.0, 3.1, atau 3.2 asli dan revisi. Periksa tingkat keparahan dan jalur bidang yang terpengaruh, lalu unduh laporan Penurunan Harga atau JSON untuk ditinjau.

Memilih pengaturan

OpsiApa yang berubah
Spesifikasi asliReferensi dalam file spesifikasi diikuti. Referensi file atau URL eksternal tidak diambil dan muncul sebagai temuan tinjauan. Skema rekursif dibandingkan pada kemunculan pertama dan ditandai untuk ditinjau.
Periksa kompatibilitasPemeriksa membandingkan operasi, parameter, isi permintaan, kode respons, dan tipe media, ditambah perubahan skema umum seperti properti yang dihapus, properti permintaan baru yang diperlukan, perubahan tipe, dan nilai enum. Temuannya mencakup operasi yang terkena dampak dan jalur lapangan.

Contoh dan hasil yang diharapkan

Jika respons GET /users/{id} yang direvisi mengharuskan kolom `email` opsional, laporan akan menandai kontrak respons yang diubah. Referensi `$ref` lokal diikuti; referensi eksternal dan komposisi skema yang kompleks dipanggil untuk ditinjau secara manual. Ini bukan validator spesifikasi lengkap atau pengujian API yang sedang berjalan.

Jika tidak berfungsi

  • Hasilnya adalah tinjauan kontrak statis, bukan validator kesesuaian OpenAPI, pengujian API runtime, atau audit keamanan yang lengkap. Perilaku server, logika otorisasi, dan komposisi skema yang kompleks memerlukan tinjauan manual. Laporan tersebut mengatakan referensi atau struktur rekursif mana yang tidak sepenuhnya diperiksa.
  • Jika penguraian gagal, periksa sintaks JSON atau YAML sebelum meninjau temuan API. Letakkan referensi lokal yang diperlukan di dokumen yang sama. Referensi eksternal dan skema yang tidak didukung perlu ditinjau manual; alat tidak mengambilnya atau menguji server aktif.

Perubahan apa yang diperiksa?

Pemeriksa membandingkan operasi, parameter, isi permintaan, kode respons, dan tipe media, ditambah perubahan skema umum seperti properti yang dihapus, properti permintaan baru yang diperlukan, perubahan tipe, dan nilai enum. Temuannya mencakup operasi yang terkena dampak dan jalur lapangan.

Bagaimana referensi ditangani?

Referensi dalam file spesifikasi diikuti. Referensi file atau URL eksternal tidak diambil dan muncul sebagai temuan tinjauan. Skema rekursif dibandingkan pada kemunculan pertama dan ditandai untuk ditinjau.

Apa yang ada di luar cek ini?

Hasilnya adalah tinjauan kontrak statis, bukan validator kesesuaian OpenAPI, pengujian API runtime, atau audit keamanan yang lengkap. Perilaku server, logika otorisasi, dan komposisi skema yang kompleks memerlukan tinjauan manual. Laporan tersebut mengatakan referensi atau struktur rekursif mana yang tidak sepenuhnya diperiksa.

Anda mungkin juga membutuhkannya