Lewati ke konten

Validator OpenAPI

Periksa dokumen OpenAPI 3.0, 3.1, atau 3.2 maupun Swagger 2.0 dalam YAML atau JSON dan dapatkan ringkasan endpoint serta schemanya. Validator memeriksa kolom wajib, kesesuaian templat jalur dengan parameter jalur, lokasi parameter, kode respons, ID operasi duplikat, dan setiap $ref lokal, serta mencantumkan setiap masalah beserta lokasinya.

Reset

Pertanyaan yang sering diajukan

Apa yang diperiksa oleh validator?

Alat ini memeriksa versi openapi atau swagger, info.title dan info.version, memastikan jalur diawali garis miring, setiap {parameter} dalam jalur memiliki parameter jalur wajib yang cocok dan sebaliknya, nama dan lokasi parameter, kode serta deskripsi status respons, parameter duplikat, nilai operationId duplikat, dan setiap $ref lokal mengarah ke sesuatu di dalam dokumen.

Apakah ini validasi JSON Schema lengkap terhadap spesifikasi?

Tidak. Alat ini memeriksa aturan struktural di atas, yang dapat menangkap sebagian besar kesalahan dalam dokumen yang ditulis tangan, tetapi tidak memvalidasi setiap kolom terhadap meta-schema resmi atau memeriksa isi schema Anda.

Apa yang ditampilkan ringkasan?

Versi spesifikasi dan API, judul, tabel semua endpoint beserta metode, jalur, operationId, ringkasan, dan kode responsnya, serta nama schema di bawah components.schemas, atau definitions dalam Swagger 2.0.

Apakah referensi eksternal diikuti?

Tidak. Referensi ke file lain atau URL tidak diambil dan tidak dilaporkan. Hanya referensi yang diawali # yang diselesaikan di dalam dokumen yang ditempel.

Apa perbedaan antara kesalahan dan peringatan?

Error melanggar aturan spesifikasi, misalnya deskripsi respons yang tidak ada atau parameter jalur yang tidak dideklarasikan. Peringatan menunjukkan hal yang diizinkan tetapi biasanya tidak disengaja, seperti operasi GET dengan badan permintaan atau dokumen tanpa operationId.

Apakah OpenAPI 3.1 mengubah hal yang diwajibkan?

Ya. Dalam OpenAPI 3.1 dan 3.2, operasi tidak lagi memerlukan objek responses, dan dokumen dapat memiliki webhooks atau components sebagai pengganti paths. Validator menerapkan aturan tersebut saat kolom openapi diawali 3.1 atau 3.2.

Tentang OneClick Pro

OneClick Pro adalah kumpulan gratis berisi lebih dari 150 alat web untuk pekerjaan sehari-hari: mengonversi gambar dan satuan, memformat dan memvalidasi kode, memeriksa domain dan SEO, serta bekerja dengan teks, tanggal, dan angka. Setiap alat dapat digunakan tanpa registrasi atau berlangganan, dan apa pun yang Anda masukkan hanya digunakan untuk menghitung hasil dan tidak pernah disimpan. Gunakan sebagai kotak alat praktis untuk tugas sesekali, atau simpan alat yang Anda gunakan setiap hari ke bookmark.