Softonic

Validator Swagger 2.0

Langkah 1 / 2
Berikutnya

Tempel definisi Swagger 2.0, dalam format JSON atau YAML, untuk memeriksa apakah ada kolom versi swagger, objek info dengan title dan version, serta objek paths. Entri path diperiksa apakah diawali garis miring dan apakah ada kunci yang bukan operasi standar.

Cara memeriksa berkas Swagger 2.0

  1. 1

    Salin definisi Anda

    Salin seluruh `swagger.json` atau `swagger.yaml`, mulai dari baris `swagger: "2.0"`.

  2. 2

    Tempel ke dalam kolom

    Tempel ke dalam kolom dokumen OpenAPI / Swagger.

  3. 3

    Jalankan pemeriksaan

    Lanjutkan ke langkah hasil untuk mendapatkan galat dan peringatan.

  4. 4

    Perbarui dan periksa ulang

    Terapkan perbaikan di berkas Anda dan tempel versi baru hingga laporannya bersih.

Apa yang dihitung sebagai lolos untuk Swagger 2.0

Untuk berkas 2.0, pemeriksaan versi terpenuhi oleh kunci swagger di tingkat atas. Alat ini tidak memverifikasi bahwa nilainya "2.0", sehingga nomor yang salah tidak akan tertangkap. Selain versi, dibutuhkan info.title, info.version, dan objek paths.

Kolom yang khusus untuk Swagger 2.0, seperti host, basePath, schemes, definitions, dan securityDefinitions, tidak diperiksa. host yang hilang atau blok definitions yang rusak tidak akan dilaporkan.

Contoh kerja

{
  "swagger": "2.0",
  "info": { "title": "Shop API", "version": "1.0" },
  "paths": {
    "/products": {
      "get": { "summary": "List products" },
      "x-internal": true
    }
  }
}

Kolom versi, info, dan paths semuanya ada, jadi tidak ada galat. Laporan menampilkan satu peringatan:

Temuan Jenis Alasan
Unknown method ‘x-internal’ on /products. Peringatan Kunci bukan operasi standar atau kolom item path

Dokumen tetap dilaporkan valid karena peringatan tidak memblokir validitas. Kunci ekstensi vendor seperti x-internal sah dalam Swagger 2.0, sehingga Anda boleh membiarkannya.

Migrasi dari 2.0

Jika Anda berencana pindah ke OpenAPI 3.x, Anda dapat menempel berkas yang sudah dikonversi ke kotak yang sama dan membandingkan hasilnya. Pemeriksaannya sama, dengan kolom openapi menggantikan swagger. Untuk pekerjaan migrasi yang sebenarnya, gunakan konverter dan linter lengkap, karena alat ini tidak menerjemahkan pengaturan definitions atau host.

Kapan pemeriksaan cepat sudah cukup

Definisi Swagger 2.0 sering bertahan bertahun-tahun di repositori dan diedit secara manual. Pemeriksaan struktural cepat berguna ketika Anda mewarisi definisi seperti itu, ketika sebuah alat menolak memuatnya dan Anda menduga ada kolom yang hilang, atau ketika Anda menggabungkan dua berkas dan ingin memastikan hasilnya masih memiliki bagian info dan paths. Untuk aturan 2.0 yang lengkap, termasuk definitions dan pengaturan keamanan, lanjutkan dengan linter khusus.

Ingat bahwa laporan yang bersih hanya merupakan pernyataan tentang struktur. Operasi tanpa respons, tipe parameter yang salah, dan referensi yang belum terselesaikan berada di luar pemeriksaan ini, jadi uji berkas juga di alat dokumentasi atau pembuatan kode Anda.

Pertanyaan yang Sering Diajukan

Tidak. Alat ini memeriksa keberadaan kolom swagger atau openapi, bukan isinya.

Tidak. Hanya kolom versi, objek info, objek paths, dan entri di bawah setiap path yang diperiksa.

Bisa. Teks dibaca sebagai JSON terlebih dahulu dan sebagai YAML jika gagal. Biarkan indentasinya tidak berubah saat menempel.

Kolom parameters, summary, description, dan servers di tingkat path termasuk dalam daftar kunci yang diterima, sehingga tidak memicu peringatan metode yang tidak 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