Softonic

Validator Spesifikasi OpenAPI Online

Langkah 1 / 2
Berikutnya

Tempel spesifikasi OpenAPI atau Swagger Anda di atas untuk mendapatkan daftar galat dan peringatan. Halaman ini menjelaskan arti setiap pesan dan cara memperbaikinya, sehingga Anda bisa beralih dari laporan merah ke laporan bersih dengan cepat. Galat membuat dokumen tidak valid; peringatan tidak.

Cara memeriksa spesifikasi dan menindaklanjuti laporan

  1. 1

    Tempel spesifikasinya

    Tempel dokumen Anda dalam format JSON atau YAML ke dalam kolom.

  2. 2

    Buka hasilnya

    Lanjutkan ke langkah hasil untuk melihat pesan valid atau daftar galat.

  3. 3

    Cocokkan setiap pesan

    Temukan pesan di tabel di bawah dan terapkan perbaikannya di berkas sumber Anda.

  4. 4

    Tempel ulang

    Jalankan lagi hingga tidak ada galat tersisa, lalu tentukan peringatan mana yang layak diperbaiki.

Membaca pesan galat

Pesan Artinya Perbaikan
Could not parse as JSON or YAML. Teks tidak dapat dibaca dalam format apa pun Perbaiki sintaksis: koma berlebih, indentasi keliru, kurung yang belum ditutup
Missing ‘openapi’ or ‘swagger’ version field. Tidak ada kunci versi di tingkat atas Tambahkan openapi: 3.0.3 atau swagger: "2.0"
Missing ‘info’ object. Tidak ada bagian info Tambahkan info dengan title dan version
info.title is required. info tidak memiliki title Tambahkan title di bawah info
info.version is required. info tidak memiliki version Tambahkan version di bawah info (versi API Anda)
Missing ‘paths’ object. Tidak ada bagian paths Tambahkan paths, meskipun masih kosong di awal

Galat menentukan apakah dokumen dilaporkan valid. Perbaiki semuanya terlebih dahulu.

Membaca peringatan

Pesan Artinya Perbaikan
Path ‘x’ should start with ‘/’. Sebuah kunci di bawah paths tidak diawali garis miring Ganti nama menjadi /x
Unknown method ‘x’ on /path. Sebuah kunci di bawah path tidak ada dalam daftar yang dikenal Periksa salah ketik, atau abaikan jika itu ekstensi yang disengaja atau trace

Daftar yang dikenal adalah get, post, put, patch, delete, head, options, parameters, summary, description, dan servers. Ekstensi vendor yang diawali x- tidak ada dalam daftar tersebut, sehingga juga muncul sebagai peringatan.

Yang tidak dapat disampaikan pemeriksaan online

Laporan hanya mencakup struktur. Pemeriksaan ini tidak mengikuti tautan $ref, tidak memeriksa definisi skema, dan tidak menandai nilai operationId yang hilang. Anggap lolosnya pemeriksaan sebagai konfirmasi bahwa berkas berbentuk dokumen OpenAPI, lalu gunakan linter lengkap sebelum mempublikasikan dokumentasi atau menghasilkan kode klien.

Tips untuk menangani laporan yang panjang

Mulailah dari atas: galat parsing berarti tidak ada hal lain yang bisa diandalkan, jadi perbaiki itu lebih dulu. Berikutnya tangani kolom tingkat atas yang hilang, karena cepat ditambahkan. Baru setelah itu lihat peringatan path. Setelah setiap putaran suntingan, tempel seluruh berkas lagi dan bukan potongannya, karena pemeriksaan membutuhkan dokumen lengkap untuk menemukan info dan paths. Laporan tanpa galat dengan beberapa peringatan yang disengaja adalah titik akhir yang normal dan dapat diterima.

Pertanyaan yang Sering Diajukan

Galat berarti dokumen dilaporkan tidak valid. Peringatan menunjuk item yang layak diperiksa, misalnya path tanpa garis miring di awal, tetapi tidak mengubah hasil valid.

Belum tentu. Artinya struktur tingkat atas sudah ada. Skema, referensi, dan respons tidak diperiksa.

Kunci di bawah path dibandingkan dengan daftar tetap metode HTTP dan beberapa kolom item path. Kunci x- tidak ada dalam daftar tersebut, sehingga ditandai sebagai peringatan. Anda boleh membiarkannya.

Tidak. Galat mengikuti urutan pemeriksaan: kolom version lebih dulu, lalu info, lalu paths. Tidak ada nomor baris.

Alat Terkait

Generator Konfigurasi Webpack

Buat webpack.config.js untuk webpack 5 bagi JavaScript biasa, React, atau Vue: TypeScript, Babel, CSS atau Sass, gambar, HtmlWebpackPlugin, server pengembangan, dan baris npm install.

Referensi Tabel ASCII

Tabel ASCII lengkap dari 0 sampai 127 dengan desimal, heksadesimal, oktal, biner, dan referensi karakter numerik HTML untuk setiap karakter, termasuk kode kontrol seperti NUL, LF, dan DEL.

Referensi Karakter HTML

Daftar entitas HTML yang dapat dicari, beserta kode bernama dan kode numeriknya, serta fitur salin dengan satu klik untuk karakter khusus dan simbol.

Validator XSD

Validasi dokumen XML terhadap skema XSD dan laporkan ketidakcocokan elemen dan tipe dengan nomor baris persis.

Dekoder Protocol Buffers

Dekode byte wire-format Protobuf secara lokal dari hex, Base64, Base64URL, teks, atau file; periksa kandidat field yang tepat dan ekspor laporan privat.

XML Formatter

Pretty-print dokumen XML dengan indentasi konsisten dan tangkap kesalahan well-formedness lengkap dengan nomor baris persis.

Alat ini tersedia dalam bahasa lain

Panduan dan contoh penggunaan