Redoc

Penampil dokumentasi API open-source yang menghasilkan dokumentasi indah, responsif, dan interaktif dari file spesifikasi OpenAPI (Swagger).

Yang Dapat Dilakukan Setelah Deploy

1. Kunjungi domain Anda — Lihat dokumentasi API Petstore default yang dirender dengan Redoc
2. Muat spesifikasi Anda — Arahkan Redoc ke URL spesifikasi OpenAPI/Swagger JSON atau YAML melalui variabel lingkungan SPEC_URL
3. Jelajahi tata letak tiga panel — Navigasi menu kiri, konten tengah, dan contoh kode kanan
4. Cari API — Gunakan pencarian bawaan untuk menemukan endpoint dan skema dengan cepat
5. Bagikan deep link — Salin URL yang menghubungkan langsung ke endpoint atau skema tertentu

Fitur Utama

• Tata letak responsif tiga panel dengan menu, konten, dan contoh kode
• Mendukung spesifikasi OpenAPI 3.1, 3.0, dan Swagger 2.0
• Contoh permintaan/respons interaktif dengan sampel multi-bahasa
• Fungsi pencarian bawaan di semua endpoint dan skema
• Deep link ke operasi, tag, dan skema tertentu
• Pembuatan contoh kode otomatis
• Dukungan rendering sisi server untuk SEO
• Tema dan opsi branding yang dapat dikustomisasi
• Dukungan Markdown dalam deskripsi
• Desain responsif ramah perangkat mobile

Lisensi

MIT — GitHub