https://github.com/dreamshive/open-swagger

Modern Swagger/OpenAPI integration for AdonisJS v6 with Scalar UI
https://github.com/dreamshive/open-swagger

adonisjs api-documentation openapi scalar swagger typescript

Last synced: about 2 months ago
JSON representation

Modern Swagger/OpenAPI integration for AdonisJS v6 with Scalar UI

• Host: GitHub
• URL: https://github.com/dreamshive/open-swagger
• Owner: DreamsHive
• License: mit
• Created: 2025-09-11T19:58:16.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-09-29T09:27:33.000Z (6 months ago)
• Last Synced: 2025-09-29T10:27:49.657Z (6 months ago)
• Topics: adonisjs, api-documentation, openapi, scalar, swagger, typescript
• Language: TypeScript
• Homepage: https://adonis-open-swagger.dreamshive.io/
• Size: 368 KB
• Stars: 9
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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](https://open-swagger.dreamshive.io/)

## Contributing

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

## License

MIT License - see [LICENSE](LICENSE) file for details.