Cara menggunakan Validator OpenAPI / Swagger
- Tempel
openapi.yaml/swagger.jsonkamu, atau buka filenya. - Versi (OpenAPI 3.1, 3.0 atau Swagger 2.0) akan terdeteksi otomatis.
- Perbaiki error skema terlebih dahulu. Setiap error menampilkan lokasinya di dokumen.
- Periksa pemeriksaan tambahan dan daftar endpoint.
Apa saja yang diperiksa
| Pemeriksaan | Detail |
|---|---|
| Skema resmi | Dokumen divalidasi terhadap JSON Schema dari OpenAPI Initiative untuk versinya (3.1, 3.0 atau Swagger 2.0): field wajib, key yang diizinkan, tipe nilai |
$ref rusak | Setiap referensi lokal (#/components/schemas/Pet) harus mengarah ke sesuatu yang ada |
operationId unik | Duplikat akan merusak generator SDK dan tautan dokumentasi |
| Parameter path | Setiap {param} di path harus dideklarasikan dengan in: path dan required: true, begitu pula sebaliknya |
| Response | Setiap operasi harus memiliki minimal satu response |
| Saran | operationId, servers atau info.description yang belum ada |
Versi OpenAPI
- Swagger 2.0 —
swagger: "2.0",definitions,host/basePath. - OpenAPI 3.0 —
components,servers,requestBody; skemanya berupa subset dari JSON Schema draft-04 dengannullable. - OpenAPI 3.1 — sepenuhnya selaras dengan JSON Schema 2020-12 (
type: [string, "null"]sebagai penggantinullable), dan menambahkanwebhooks.
Batasan
Referensi eksternal ke file lain atau URL tidak diambil. Gabungkan spec multi-file terlebih dahulu (misalnya dengan redocly bundle). Validasi skema hanya melaporkan masalah struktural. Aturan gaya seperti konvensi penamaan memerlukan linter seperti Spectral. Untuk memvalidasi contoh payload terhadap skema kamu, gunakan validator JSON Schema. Untuk memeriksa sintaks YAML, gunakan validator YAML. Dan untuk mencoba API secara langsung, gunakan API tester.
Juga dicari sebagai: validator swagger, validator openapi, validasi openapi, validator openapi 3.1, validator swagger 2.0, lint openapi, validasi spec api.
Tool yang cocok dipakai bersama Validator OpenAPI / Swagger
- Format JSON — Tempel JSON untuk dirapikan, di-minify, atau divalidasi.
- cURL ke Code — Tempel perintah curl dari dokumentasi API atau “Copy as cURL” di DevTools browser, lalu dapatkan kode siap pakai untuk enam bahasa, dengan header, body, dan autentikasi yang ikut terbawa.
- Penguji JSONPath — Ketik query JSONPath dan langsung lihat apa yang dipilihnya, lengkap dengan path persis dari setiap hasil.
- JSON ke YAML — Tempel JSON dan dapatkan YAML yang rapi untuk manifest Kubernetes, Docker Compose, GitHub Actions, atau file konfigurasi apa pun.
Pertanyaan yang sering diajukan
Apakah mendukung OpenAPI 3.1?
Ya. OpenAPI 3.1.x, 3.0.x dan Swagger 2.0 masing-masing divalidasi terhadap skema resminya.
Kenapa satu kesalahan menghasilkan banyak error?
Skema resmi menggunakan alternatif (oneOf), sehingga satu nilai yang salah bisa membuat beberapa cabang gagal. Tool ini menyaring pesan menjadi yang paling spesifik. Perbaiki yang pertama, lalu periksa ulang.
Apakah bisa mengikuti $ref ke file lain?
Tidak, hanya referensi di dalam dokumen yang sama. Gabungkan spec multi-file menjadi satu file terlebih dahulu.
Apakah spec API saya diunggah?
Tidak. Validasi berjalan sepenuhnya di browser kamu, sehingga desain API internal tetap privat.
Bisakah saya memasang Validator OpenAPI / Swagger sebagai aplikasi web dan memakainya offline?
Bisa. Validator OpenAPI / Swagger adalah aplikasi web (PWA) yang bisa dipasang. Pemasangannya lewat browser kamu, bukan diunduh dari toko aplikasi. Klik Pasang aplikasi di bagian atas halaman ini di Chrome atau Edge (Windows, macOS, Linux, ChromeOS) atau di Android. Di iPhone dan iPad, gunakan Bagikan → Tambahkan ke Layar Utama, dan di Safari 17+ pada Mac, gunakan File → Tambahkan ke Dock. Setelah itu, aplikasi akan terbuka di jendelanya sendiri dengan ikonnya sendiri. Karena berjalan sepenuhnya di browser kamu, aplikasi ini tetap bisa dipakai offline. Firefox di desktop tidak bisa memasang aplikasi web. Cara memasang aplikasi.