openapi gui

Openapi-Gui

OpenAPI-GUI adalah GUI untuk membuat dan mengedit OpenAPI versi 3.0.x JSON/YAML Definisi. Dalam bentuk saat ini, ini paling berguna sebagai alat untuk memulai dan mengedit definisi OpenAPI sederhana. Definisi OpenAPI 2.0 yang diimpor secara otomatis dikonversi ke V3.0.

Untuk versi Sumpah / OpenAPI 2.0 saja, lihat di sini. Versi itu saat ini tidak terpisah selain dari perbaikan keamanan.

Proyek ini awalnya merupakan garpu iodoctor Daryl Kuhn, yang pada gilirannya terinspirasi oleh iodoctor oleh Brandon West yang ditulis di Ruby. Sejarah lengkap proyek ini dipertahankan di GitHub.

Keterangan

Cara kerjanya

Pilih definisi OpenAPI 2.0 atau 3.0.x yang ada untuk mengunggah, atau membuat definisi baru dan mulai menambahkan jalur, operasi, dan parameter. Ketika definisi yang ada digunakan, itu diuraikan dan bentuk untuk mengedit setiap jalur, operasi dan parameter akan dibuat.

Anda dapat memuat definisi yang ada dengan menambahkan ?url= parameter kueri ke halaman awal awal dengan nilai menjadi URL ke definisi yang ingin Anda muat. Saat menggunakan Docker, Anda dapat mengatur nilai parameter kueri url ke %2fserve untuk mengambil definisi yang Anda lewati pada garis komando Docker.

Klik item dari menu di sebelah kiri untuk mulai mengedit. Lihat output JSON/YAML kapan saja dengan memilih salah satu tab "Ekspor". Setelah selesai, unduh output untuk menyimpannya secara lokal atau salin clipboard Anda. Openapi-Gui hanya menyimpan satu definisi pada satu waktu, dan ini ada di penyimpanan lokal browser Anda. Pastikan Anda menyimpan output JSON/YAML secara lokal.

Sebelum melakukan tindakan destruktif, OpenAPI-Gui menyimpan keadaan definisi saat ini. Di semua waktu lain Anda harus ingat untuk memilih Simpan secara manual.

Teknologi

OpenAPI-GUI berjalan sepenuhnya sisi klien menggunakan sejumlah kerangka kerja JavaScript termasuk Vue.js, JQuery dan Bulma untuk CSS.

Untuk mendapatkan aplikasi dan berjalan, telusuri saja ke versi langsung di halaman GitHub, menggunakan klon ke halaman GitHub, menggunakan Heroku menggunakan tombol di bawah ini, atau mengkloning repo dan mengarahkan browser di index.html atau meng -hostnya sendiri - tidak bisa lebih sederhana. Lebih banyak informasi teknis di sini.

Anda hanya perlu npm install modul Node.js jika Anda ingin menggunakan server web tertanam openapi-gui (yaitu tidak jika Anda menjalankan server web Anda sendiri), jika tidak, mereka hanya ada untuk penyebaran PAAS.

Opsi CLI

 -d, --definition    serve the given OAS definition
-l, --launch        start a web-browser pointing to the GUI
-p, --port          specify the port to run on, defaults to $PORT or 3000
-w, --write         enable writing back to the source definition

Berlari dengan Docker

Jika Anda tidak memiliki lingkungan pengembangan simpul lokal, atau jika Anda lebih suka menjalankan OpenAPI Gui dalam wadah Docker, Anda dapat melakukannya dengan beberapa langkah sederhana:

1. Klon Repositori.
2. Jalankan docker build -t mermade/openapi-gui . Untuk membangun gambar Docker ( mermade/openapi-gui )
3. Jalankan docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui untuk menjalankan server di port 8080.
4. Arahkan ke http://localhost:8080 di browser favorit Anda.
5. Setelah selesai, matikan server dengan menjalankan docker stop openapi-gui && docker rm openapi-gui

Atau Anda dapat menarik gambar Docker yang sudah dibangun:

• docker pull mermade/openapi-gui

Batasan

• OpenAPI-GUI akan de-referensi parameter bersama.
• Definisi harus mandiri tanpa eksternal $ref S. Ini kemungkinan akan segera diselesaikan (ho-ho) .
• Mengedit respons / contoh / skema tubuh akan mendereferensinya.
• OpenAPI-GUI tidak akan selalu mempertahankan ekstensi vendor, misalnya jika parameter dihapus dan diciptakan kembali.
• Openapi-Gui tidak akan mempertahankan komentar dari definisi yang diimpor dalam format YAML.

Todo

• Lihat daftar TODO dan status Dukungan Spesifikasi OpenAPI 3.0 saat ini.