Softonic

Validator OpenAPI YAML

Langkah 1 / 2
Berikutnya

Tempel openapi.yaml Anda dan validator memeriksa bagian yang dibutuhkan setiap spesifikasi: kolom version, objek info dengan title dan version, serta objek paths. Alat ini juga memberi peringatan untuk kunci path yang tidak diawali garis miring dan kunci operasi yang tidak dikenalinya.

Cara memvalidasi berkas OpenAPI YAML

  1. 1

    Salin YAML-nya

    Salin seluruh isi `openapi.yaml` atau `swagger.yaml`, dengan mempertahankan indentasinya persis seperti aslinya.

  2. 2

    Tempel ke dalam kolom

    Tempel ke dalam kotak dokumen OpenAPI / Swagger. Dalam YAML, indentasi adalah struktur, jadi jangan menulis ulang atau mengatur ulang tata letaknya.

  3. 3

    Jalankan validasi

    Lanjutkan ke langkah hasil dan baca galat serta peringatannya.

  4. 4

    Perbaiki dan periksa ulang

    Perbaiki setiap item yang dilaporkan di berkas Anda, tempel versi barunya, dan jalankan lagi.

Mengapa indentasi memengaruhi hasil

Dalam YAML, tingkat sarang kunci menentukan objek mana yang dimiliki sebuah kolom. Jika version berada pada indentasi yang sama dengan info, bukan satu tingkat di bawahnya, dokumen tetap berupa YAML yang dapat dibaca, tetapi info.version hilang dan pemeriksaan melaporkannya. Hal yang sama berlaku untuk paths: kunci path yang keliru terindentasi di bawah info berarti objek paths tingkat atas hilang.

Gunakan spasi, bukan tab, dan jaga satu langkah yang konsisten, misalnya dua spasi per tingkat.

Contoh kerja

openapi: 3.0.3
info:
  title: Pets API
paths:
  /pets:
    get:
      summary: List pets

Kolom version, info.title, dan paths ada, dan /pets diawali garis miring dengan get sebagai metode yang dikenal. Yang kurang hanya satu: info.version. Laporannya mendaftar:

Temuan Jenis
info.version is required. Galat

Tambahkan version: 1.0.0 di bawah info dengan indentasi dua spasi, dan dokumen akan dilaporkan valid secara struktural.

Jaga dokumen tetap sederhana agar pembacaan andal

Pemeriksaan paling baik membaca pemetaan YAML biasa: baris kunci: nilai sederhana yang disarangkan dengan indentasi yang konsisten. Jika dokumen dengan fitur YAML lanjutan, seperti anchor atau blok multibaris, dilaporkan tidak dapat dibaca atau menampilkan kolom yang hilang, coba salinan JSON dari spesifikasi yang sama untuk memastikan apakah masalahnya ada pada isi atau pada sintaksis YAML.

Hasil yang bersih hanya mengonfirmasi kerangkanya. Pemeriksaan ini tidak menyelesaikan tautan $ref dan tidak memeriksa skema.

Alur kerja praktis untuk spesifikasi YAML

Sunting dalam langkah kecil dan periksa ulang. Setelah Anda menambahkan path baru atau memindahkan blok, tempel berkas lagi agar indentasi yang salah tertangkap selagi perubahannya masih segar. Saat Anda membagi spesifikasi besar ke beberapa berkas, tempel versi gabungannya, karena pemeriksaan ini hanya membaca teks yang Anda berikan dan tidak memuat berkas lain. Salin dari editor Anda, bukan dari halaman web yang ditampilkan, karena halaman web dapat mengganti spasi dan tanda kutip dengan karakter yang tampak mirip tetapi mengubah cara YAML dibaca.

Terakhir, ingat bahwa laporan hanya mencakup apa yang dapat dilihat oleh pemeriksaan. Hasil yang bersih pada berkas YAML berarti kerangka tingkat atasnya benar, bukan bahwa setiap operasi, skema, atau referensi di dalamnya benar.

Pertanyaan yang Sering Diajukan

Spasi. YAML tidak menerima tab untuk indentasi, dan tab dapat membuat dokumen tidak terbaca atau memindahkan kolom ke tingkat yang salah.

Biasanya kolom tersebut terindentasi pada tingkat yang salah, sehingga termasuk ke objek lain dari yang Anda maksudkan. Bandingkan indentasinya dengan kunci induknya.

Pemeriksaan ini hanya mencari keberadaan kolom openapi atau swagger, bukan nilainya, sehingga versi yang diberi tanda kutip maupun tidak sama-sama lolos. Menulis "2.0" dengan tanda kutip untuk Swagger tetap kebiasaan yang baik.

Bisa. Dokumen dibaca sebagai JSON terlebih dahulu dan sebagai YAML jika gagal, sehingga kedua format berfungsi di kolom yang sama.

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