Softonic

Validator OpenAPI 3.1

Langkah 1 / 2
Berikutnya

Tempel dokumen OpenAPI 3.1 dalam format JSON atau YAML untuk memeriksa struktur tingkat atasnya. Alat ini mencari kolom openapi, objek info dengan title dan version, serta objek paths. Ini pemeriksaan struktural, jadi kata kunci skema 3.1 tidak divalidasi, dan beberapa pola yang ramah 3.1 dapat menghasilkan peringatan atau galat yang perlu Anda ketahui.

Cara memeriksa dokumen 3.1

  1. 1

    Tempel spesifikasi 3.1 Anda

    Tempel dokumen dengan `openapi: 3.1.0` (atau nilai 3.1.x lainnya) ke dalam kolom, dalam format JSON atau YAML.

  2. 2

    Jalankan pemeriksaan

    Lanjutkan ke langkah hasil untuk melihat galat dan peringatan.

  3. 3

    Baca catatan 3.1

    Periksa apakah item yang ditandai merupakan kesalahan sungguhan atau salah satu pola 3.1 yang dijelaskan di bawah.

  4. 4

    Lanjutkan dengan linter lengkap

    Setelah strukturnya rapi, gunakan validator lengkap untuk aturan JSON Schema 2020-12.

Yang dilakukan alat ini terhadap berkas 3.1

Versi 3.1 menyelaraskan skema dengan JSON Schema 2020-12. Validator ini sama sekali tidak membaca isi skema. Ia hanya memeriksa tingkat atas dan entri path, sehingga fitur skema 3.1 seperti array tipe atau const tidak lolos maupun gagal di sini. Nilai versi itu sendiri juga tidak diperiksa: setiap kolom openapi dianggap ada.

Dua pola 3.1 yang perlu diperhatikan

Pola dalam berkas 3.1 Anda Yang dilaporkan alat
Objek webhooks dan tidak ada objek paths Galat: Missing ‘paths’ object.
Operasi trace di bawah sebuah path Peringatan: Unknown method ‘trace’ on the path
$ref sebagai kunci pada item path Peringatan: Unknown method ‘$ref’ on the path

OpenAPI 3.1 memungkinkan dokumen hanya mendeskripsikan webhooks dan tidak menyertakan paths. Alat ini mewajibkan paths, sehingga berkas seperti itu dilaporkan dengan galat meskipun spesifikasinya mengizinkannya. Menambahkan objek paths: {} yang kosong akan memenuhi pemeriksaan.

Daftar metode yang digunakan di sini adalah get, post, put, patch, delete, head, options, ditambah parameters, summary, description, dan servers. Metode trace ada dalam spesifikasi, tetapi tidak ada dalam daftar ini, sehingga memicu peringatan yang dapat Anda abaikan jika memang disengaja. Peringatan tidak membuat dokumen menjadi tidak valid.

Contoh kerja

openapi: 3.1.0
info:
  title: Events API
  version: 2.0.0
webhooks:
  newEvent:
    post:
      summary: Event delivered

Hasil: satu galat, “Missing ‘paths’ object.” Tambahkan paths: {} dan strukturnya lolos.

Kapan menggunakan ini dan kapan perlu lebih jauh

Gunakan halaman ini untuk memastikan berkas 3.1 berbentuk benar sebelum Anda membuka pull request atau membagikannya kepada mitra. Pemeriksaannya cepat dan pesannya sederhana. Setelah strukturnya benar, aturan skema 3.1 tetap memerlukan linter lengkap, karena di sanalah sebagian besar kesalahan nyata tersembunyi: deklarasi tipe yang tidak valid, referensi yang rusak, dan definisi respons yang hilang. Anggap kedua langkah ini saling melengkapi, bukan alternatif.

Jika peringatan yang ditandai memang disengaja, misalnya trace, catat di pull request Anda agar peninjau tidak bertanya-tanya. Peringatan tidak pernah mengubah hasil valid, sehingga aman untuk dibiarkan. Galat adalah item yang harus diselesaikan sebelum berkas dibagikan.

Pertanyaan yang Sering Diajukan

Tidak. Alat ini tidak membaca objek skema, sehingga kata kunci JSON Schema 2020-12 tidak diperiksa. Cakupannya hanya struktur tingkat atas dan entri path.

Pemeriksaan mewajibkan objek paths. Berkas 3.1 yang hanya berisi webhooks tidak memilikinya, sehingga dilaporkan galat paths yang hilang. Tambahkan paths: {} yang kosong untuk lolos.

Tidak. Alat ini hanya memeriksa apakah kolom openapi atau swagger ada, bukan apa nilainya.

Belum tentu. trace adalah operasi yang valid dalam spesifikasi. Alat ini hanya tidak memasukkannya ke dalam daftar metode yang dikenal.

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