What is Adonis Open Swagger
Introducing Adonis Open Swagger
Adonis Open Swagger is an automatic API documentation generator for AdonisJS that brings end-to-end type safety to your full-stack applications. Built for developers who value productivity, it eliminates the need for third-party documentation tools while providing a modern, beautiful UI powered by Scalar.
Philosophy
Documentation Without the Overhead
We built Adonis Open Swagger because maintaining API documentation in separate tools like Postman is tedious and error-prone. Your code is the source of truth—your documentation should reflect that automatically.
With decorator-driven documentation, you explicitly mark which routes to document. No surprises, no bloat, just clean, intentional API docs that stay in sync with your code.
End-to-End Type Safety
Type safety shouldn't stop at your backend. Adonis Open Swagger generates OpenAPI schemas that integrate seamlessly with openapi-typescript, enabling your frontend to consume fully typed API clients.
Write your backend in AdonisJS, generate the schema, and let your frontend enjoy autocomplete, type checking, and confidence that your API contracts are always correct.
Modern Developer Experience
Gone are the days of clunky Swagger UI. Adonis Open Swagger uses Scalar for a sleek, modern documentation interface that your team will actually enjoy using.
With native support for TypeBox, Zod, and VineJS schemas, you can use the validation library you prefer without compromising on documentation quality.
When to Use Adonis Open Swagger
Adonis Open Swagger is designed for AdonisJS developers who want to move fast without sacrificing quality.
API-First Applications
Building a REST API? Adonis Open Swagger automatically generates comprehensive documentation from your routes, controllers, and validation schemas. Your API docs are always up-to-date because they're generated from your actual code.
Perfect for:
- Public APIs that need professional documentation
- Internal microservices requiring clear contracts
- Mobile app backends where type safety matters
- SaaS platforms with developer-facing APIs
Full-Stack Type Safety
If you're building a full-stack application with AdonisJS on the backend and a modern frontend framework (React, Vue, Svelte), Adonis Open Swagger bridges the gap.
Generate OpenAPI schemas, feed them to openapi-typescript, and enjoy type-safe API calls throughout your frontend. Refactor your backend with confidence—TypeScript will catch breaking changes before they reach production.
Team Collaboration
When multiple developers work on the same API, documentation becomes critical. Adonis Open Swagger ensures everyone—backend developers, frontend developers, and QA engineers—has access to accurate, interactive API documentation.
No more "check the code" or "ask in Slack." Just open the docs.
Features
Modern UI
Uses Scalar instead of traditional Swagger UI for a beautiful, interactive documentation experience
Decorator-driven
Documentation only generated for routes with explicit decorators—intentional and clean
Schema Support
Native TypeBox, Zod, and VineJS schema support alongside raw JSON Schema
Components Feature
Automatic OpenAPI component schema generation for openapi-typescript integration
Type Safety
Generate schemas that power fully typed frontend API clients
Customizable
Flexible configuration and theming options to match your brand
CLI Integration
Seamless integration with AdonisJS Ace commands for easy setup and generation
TypeScript
Full TypeScript support with proper type definitions throughout
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
Always in Sync
Documentation automatically reflects your latest code changes
Last updated on