Tidak suka iklan? Pergi Bebas Iklan Hari ini 

Validator Spesifikasi OpenAPI / Swagger

DataPengembang

IKLAN · MENGHAPUS?

MEMASUKKAN

Proses Otomatis

KELUARAN

Sisi klien

IKLAN · MENGHAPUS?

Memandu

Validator Spesifikasi OpenAPI / Swagger

Validasi spesifikasi OpenAPI 3.0, 3.1, atau Swagger 2.0 Anda secara instan. Tempel YAML atau JSON, dapatkan daftar terstruktur berisi kesalahan dan peringatan dengan jalur JSON Pointer, dan cetak rapi spesifikasi Anda untuk dokumentasi yang bersih.

Cara Penggunaan

Tempel spesifikasi OpenAPI atau Swagger Anda ke kolom input. Validator secara otomatis mendeteksi apakah itu YAML atau JSON dan versi spesifikasi mana yang Anda gunakan. Hasilnya menampilkan ringkasan endpoint, skema, kesalahan, dan peringatan. Setiap masalah menyertakan jalur JSON Pointer sehingga Anda dapat menemukan masalah dengan cepat.

Fitur

Dukungan Multi-Versi – Memvalidasi spesifikasi Swagger 2.0, OpenAPI 3.0.x, dan OpenAPI 3.1.x
Validasi Struktural – Memeriksa kolom yang diperlukan (info, paths, version), tipe yang benar, dan struktur skema
Validasi Semantik – Mendeteksi operationId duplikat, metode HTTP yang tidak valid, referensi $ref yang rusak, dan inkonsistensi parameter jalur
Jalur Kesalahan – Setiap masalah menyertakan jalur JSON Pointer untuk lokasi yang tepat
Cetak Rapi – Format ulang spesifikasi Anda sebagai JSON atau YAML yang bersih dengan lekukan yang tepat
Ringkasan Spesifikasi – Tinjauan instan: versi, total endpoint, skema, kesalahan, dan peringatan
Klien 100% – Spesifikasi API Anda tidak pernah meninggalkan peramban Anda

IKLAN · MENGHAPUS?

 Tanya Jawab Umum

Apa perbedaan antara Swagger 2.0 dan OpenAPI 3.0?

Swagger 2.0 adalah format spesifikasi API asli yang dikembangkan oleh SmartBear. Ketika spesifikasi disumbangkan ke OpenAPI Initiative pada tahun 2015, namanya diubah menjadi OpenAPI. Versi 3.0 memperkenalkan peningkatan signifikan termasuk dukungan yang lebih baik untuk callback, tautan, beberapa server, dan struktur komponen yang lebih bersih. Kedua format tersebut tidak kompatibel secara langsung.
Mengapa operationId perlu unik dalam spesifikasi OpenAPI?

operationId berfungsi sebagai pengidentifikasi unik untuk setiap operasi API. Generator kode menggunakannya untuk membuat nama metode di SDK klien, alat dokumentasi menggunakannya untuk tautan jangkar, dan kerangka kerja pengujian menggunakannya untuk merujuk endpoint tertentu. operationId duplikat menyebabkan konflik di semua alat hilir ini.
Apa itu JSON Pointer dan bagaimana cara membaca jalur kesalahan validasi?

JSON Pointer (RFC 6901) adalah sintaks string untuk mengidentifikasi nilai tertentu dalam dokumen JSON. Misalnya, /paths/~1users/get/parameters/0 menunjuk ke parameter pertama dari operasi GET /users. ~1 adalah escape untuk garis miring dalam segmen jalur. Membaca pointer ini memberi tahu Anda secara tepat di mana dalam spesifikasi Anda kesalahan validasi terjadi.
Haruskah saya menulis spesifikasi OpenAPI saya dalam YAML atau JSON?

Kedua format sepenuhnya didukung dan setara secara fungsional. YAML umumnya lebih disukai untuk spesifikasi yang ditulis tangan karena lebih mudah dibaca dan mendukung komentar. JSON lebih baik untuk spesifikasi yang dihasilkan mesin dan manipulasi programatik. Kebanyakan alat menerima salah satu format, jadi pilihlah yang paling mudah dikelola oleh tim Anda.