Buka spesifikasi API dengan lebih daripada satu fail YAML

Semua orang yang pernah mendokumentasikan REST API tahu bagaimana rasanya menulis keseluruhan fail YAML lengkap dengan semua sumber, laluan, permintaan dan skema tersebut, tetapi tiba-tiba anda mendapati diri anda menyimpan fail di mana baris terakhir mempunyai 5 digit panjang. Ya, ia menyakitkan.

Memandangkan aplikasi terbaik adalah aplikasi yang kami bina untuk diri kami sendiri, saya mendapati diri saya berada di tempat yang sama mendokumentasikan API di tempat kerja dan saya banyak mencari untuk tidak menemui satu penyelesaian yang berdaya maju untuk masalah ini, ketika itulah naluri pengaturcara kami masuk. dan kami menghabiskan lima kali masa yang sepatutnya kami membina alat baharu untuk diri kami sendiri. Itulah yang saya lakukan dan saya ingin berkongsi dengan anda semua alat baharu yang ditulis dalam Pergi untuk menggabungkan fail YAML anda pada satu fail bos untuk digunakan sebagai spesifikasi OpenAPI anda.

Memperkenalkan: GOpenAPI

GOpenAPI (Golang OpenAPI) ialah alat yang menggunakan fail yang dipanggil dirs.json untuk mengimbas fail dan direktori (ya, keseluruhan direktori bernilai yaml) ke dalam satu fail swagger.yaml pada penghujung pelaksanaan.

Anda boleh menyemak kod sumber di sini. Ambil perhatian bahawa repositori juga merupakan templat yang boleh diklon dan digunakan sebagai draf untuk mencipta spesifikasi OpenAPI pertama anda dengan alat ini (cuma pastikan anda menyimpan folder gopenapi jika anda tidak bersedia untuk memasangnya melalui go install, jika tidak, ia benar-benar boleh tanggal)

Bagaimanakah ia berfungsi (dan adakah saya membuatnya berfungsi)

Mudah, sebaik sahaja anda menjalankan gopenapi, ia membaca fail dirs.json dan mula membina spesifikasi OpenAPI dengan semua fail dan folder diisytiharkan di sana. Ambil perhatian bahawa dirs.json akan menggunakan fail untuk kunci unik seperti maklumat, pelayan dan keselamatan serta kunci yang dipanggil templat (yang hanya fail yaml OpenAPI kosong)

Sumber dan kunci yang sukar disimpan dalam satu fail (seperti laluan, skema dan permintaan) boleh disimpan dalam folder, dan ia juga boleh disebut menggunakan teg #ref biasa pada OpenAPI, kerana kesemuanya adalah pergi ke fail yang sama selepas digabungkan.

Projek ini juga disertakan dengan index.html yang boleh disampaikan secara statik dan ia juga berinteraksi dengan himpunan rasmi UI Swagger yang terkandung di dalam folder dist.

Itu semua orang

Saya harap alat ini disediakan untuk sesiapa sahaja yang (sama seperti saya) mencari banyak reddits dan repositori github hanya untuk tidak menemui alat yang mereka cari. Nah, kini anda memilikinya dan ia sumber terbuka sepenuhnya yang bermaksud, jika anda melihat sebarang peningkatan atau isu yang boleh diselesaikan saya tidak akan berfikir dua kali sebelum bekerjasama dengan anda untuk menyelesaikannya. Selain itu, saya agak naif tentang golang jadi ia mungkin mempunyai banyak perkara untuk diperbaiki pada projek ini, saya akan cuba memastikannya dikemas kini dan sentiasa memperbaikinya (kerana saya juga akan menggunakannya dengan banyak sekarang)

Terima kasih kerana membaca dan saya harap yang ini berguna kepada anda seperti yang berlaku kepada saya ;)

Atas ialah kandungan terperinci Buka spesifikasi API dengan lebih daripada satu fail YAML. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!