Viewer OpenAPI & Swagger
Render spesifikasi OpenAPI dan Swagger (JSON/YAML) menjadi dokumentasi API interaktif yang indah.
OpenAPI / Swagger Spec (JSON or YAML)
Petstore API
v1.0.0A sample Petstore API spec for demonstrating OpenAPI / Swagger rendering
https://petstore.swagger.io/v2Apa itu Viewer OpenAPI & Swagger?
Viewer OpenAPI & Swagger — Alat visualisasi spesifikasi API yang menguraikan berkas dokumen OpenAPI 3.0+ dan Swagger 2.0 (berformat JSON maupun YAML) menjadi antarmuka dokumentasi API interaktif yang indah. Pengembang dapat mengeksplorasi endpoint, parameter, skema request/response, dan menguji pemanggilan API secara langsung.
Cara menggunakan Viewer OpenAPI & Swagger
- Tempelkan spesifikasi OpenAPI/Swagger (JSON atau YAML) ke dalam editor masukan.
- Dokumentasi API interaktif akan secara otomatis di-render di panel kanan.
- Jelajahi daftar grup endpoint, metode HTTP, dan model data.
- Gunakan fitur uji coba untuk simulasi panggilan ke server API.
Contoh
Render Spesifikasi JSON
Masukan
{"openapi": "3.0.0", "info": {"title": "Sample API"}}
Keluaran
Dokumentasi interaktif dengan judul 'Sample API'.
Render Spesifikasi YAML
Masukan
swagger: "2.0" info: title: Petstore API
Keluaran
Dokumentasi Swagger Petstore API ter-render rapi.
Kesalahan umum
- Memasukkan berkas spesifikasi yang tidak sesuai dengan skema OpenAPI/Swagger.
- Mengabaikan kesalahan indentasi saat memasukkan format YAML.
- Lupa bahwa URL server API di spesifikasi harus mendukung CORS untuk fitur uji coba.
Mengapa menggunakan alat ini
- Pengalaman membaca dokumentasi API yang jernih, modern, dan interaktif.
- Tanpa instalasi server tambahan atau node_modules yang berat.
- Mendukung format masukan JSON dan YAML secara transparan.