swagger ui
v5.18.2 Released!
Swagger UI memungkinkan siapa pun - baik itu tim pengembangan Anda atau konsumen akhir Anda - untuk memvisualisasikan dan berinteraksi dengan sumber daya API tanpa memiliki logika implementasi apa pun. Ini secara otomatis dihasilkan dari spesifikasi OpenAPI Anda (sebelumnya dikenal sebagai Swagger), dengan dokumentasi visual memudahkan implementasi latar dan konsumsi sisi klien.
? Ingin mencetak kontribusi sumber terbuka yang mudah? Lihat label edisi pertama kami yang bagus.
? ️ Mencari versi yang lebih lama dari Swagger UI? Lihat cabang 2.x.
Repositori ini menerbitkan tiga modul NPM yang berbeda:
Kami sangat menyarankan agar Anda menggunakan swagger-ui alih-alih swagger-ui-dist jika Anda membangun aplikasi satu halaman, karena swagger-ui-dist secara signifikan lebih besar.
Jika Anda mencari HTML/JS/CSS yang sederhana, unduh rilis terbaru dan salin konten folder /dist ke server Anda.
Spesifikasi OpenAPI telah mengalami 5 revisi sejak penciptaan awal pada tahun 2010. Kompatibilitas antara Swagger UI dan spesifikasi OpenAPI adalah sebagai berikut:
| Versi UI Swagger | Tanggal rilis | Kompatibilitas Spesifikasi OpenAPI | Catatan |
|---|---|---|---|
| 5.0.0 | 2023-06-12 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | Tag v5.0.0 |
| 4.0.0 | 2021-11-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v4.0.0 |
| 3.18.3 | 2018-08-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v3.18.3 |
| 3.0.21 | 2017-07-26 | 2.0 | Tag v3.0.21 |
| 2.2.10 | 2017-01-04 | 1.1, 1.2, 2.0 | Tag v2.2.10 |
| 2.1.5 | 2016-07-20 | 1.1, 1.2, 2.0 | Tag v2.1.5 |
| 2.0.24 | 2014-09-12 | 1.1, 1.2 | Tag v2.0.24 |
| 1.0.13 | 2013-03-08 | 1.1, 1.2 | Tag v1.0.13 |
| 1.0.1 | 2011-10-11 | 1.0, 1.1 | Tag v1.0.1 |
Swaggerui menggunakan syal untuk mengumpulkan analisis instalasi anonim. Analisis ini membantu mendukung pengelola perpustakaan ini dan hanya berjalan selama instalasi. Untuk memilih keluar, package.json dapat mengatur bidang scarfSettings.enabled false
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
Atau, Anda dapat mengatur variabel lingkungan SCARF_ANALYTICS menjadi false sebagai bagian dari lingkungan yang menginstal paket npm Anda, misalnya, SCARF_ANALYTICS=false npm install
Anda akan membutuhkan JDK versi 7 atau lebih tinggi seperti yang diinstruksikan di sini https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server
Tes integrasi dapat dijalankan secara lokal dengan npm run e2e - Pastikan Anda tidak menjalankan server dev saat menguji!
Swagger UI bekerja dalam versi terbaru Chrome, Safari, Firefox, dan Edge.
Untuk membantu migrasi, berikut adalah masalah yang saat ini diketahui dengan 3.x. Daftar ini akan diperbarui secara teratur, dan tidak akan menyertakan fitur yang tidak diimplementasikan dalam versi sebelumnya.
collectionFormat sebagian.Harap ungkapkan masalah atau kerentanan terkait keamanan dengan mengirim email ke [email protected], alih-alih menggunakan pelacak masalah publik.
Swaggerui dilisensikan di bawah lisensi Apache 2.0. Swaggerui dilengkapi dengan file pemberitahuan eksplisit yang berisi pemberitahuan dan informasi hukum tambahan.
