Skip to content

DreamsHive/open-swagger

Repository files navigation

Adonis Open Swagger

Modern Swagger/OpenAPI integration for AdonisJS v6 with Scalar UI.

Features

  • 🚀 Modern UI: Uses Scalar instead of traditional Swagger UI
  • 🎯 Decorator-driven: Documentation only generated for routes with explicit decorators
  • 🔧 Schema Support: Native TypeBox, Zod, and VineJS schema support alongside raw JSON Schema
  • 🧩 Components Feature: Automatic OpenAPI component schema generation for openapi-typescript integration
  • 🎨 Customizable: Flexible configuration and theming options
  • 🛠️ CLI Integration: Seamless integration with AdonisJS Ace commands
  • 📦 TypeScript: Full TypeScript support with proper type definitions
  • Dynamic Loading: Leverages AdonisJS v6's lazy loading for optimal performance
  • 🏗️ Universal Compatibility: Works with all AdonisJS starter kits (API, Slim, Web, Inertia)
  • 🔧 Zero Dependencies: No need to install Edge.js separately - included in the package

Documentation

Read full documentation here

Contributing

Contributions are welcome! Please read our contributing guidelines and submit pull requests.

License

MIT License - see LICENSE file for details.