@powerduck/openapi-parser
Herhangi bir Swagger 2.0, OpenAPI 3.0, 3.1 veya 3.2 belgesini tek bir çağrıyla OpenAPI 3.2’ye dönüştürün.
Şu iki kitaplık üzerinde ince bir sarmalayıcıdır: @scalar/openapi-parser, @scalar/openapi-upgrader.
Ayrıştırma, doğrulama veya dönüştürmeyi yeniden uygulamaz; bunları birbirine bağlar ve her hataya makine tarafından okunabilir bir hata koduyla tutarlı, öngörülebilir bir yapı kazandırır.
- Paket adı:
@powerduck/openapi-parser - Sürüm:
- Lisans: MIT
- Node.js: >= 22.12.0
Özellikler
- Tüm sürümler için tek işlev — Swagger 2.0, OpenAPI 3.0.x, 3.1.x ve 3.2.x doğrulanmış bir 3.2 belgesine dönüştürülür.
- JSON ve YAML dizesi girdisi — Önceden ayrıştırılmış nesne veya ham JSON/YAML dizesi verin.
- Makine tarafından okunabilir hata kodları — Her hata,
UpgradeErrorCodeenum değeri içeren birOpenApiUpgradeErrorolarak bildirilir. - Girdiyi değiştirmez — Herhangi bir dönüştürme aşamasından önce girdi
structuredCloneile derin kopyalanır. - Döngüsel başvuru koruması — Girdideki döngüleri yığın taşmasına yol açmadan önce algılar.
- Çıktı doğrulaması — Dönüştürülen 3.2 belgesi varsayılan olarak şemaya göre doğrulanır.
- ESM ve CJS — Modern Node ve paketleyicilerde
import, Electron ana sürecinderequire()kullanın.
Sonraki adımlar
- Kurulum — kurulum ve gereksinimler
- Hızlı başlangıç — ilk belgenizi dönüştürün
- API başvuru kaynağı — tüm dışa aktarımlar, hata kodları ve seçenekler
- Örnekler — hata işleme, seçenekler ve CommonJS kullanımı