Lifetime license

Zero-config OpenAPI docs
for AdonisJS.

AdopenAPI reads your TypeScript return types and AdonisJS routes to generate a fully compliant OpenAPI 3.1.0 specification — automatically. No decorators, no comments, no maintenance.

What's included

• 🔍
  AST-powered type analysis Full TypeScript AST parser — understands generics, unions, intersections, Lucid models, and custom interfaces.
• 🛣️
  Automatic route discovery Reads your AdonisJS router config — HTTP verbs, path params, middleware, controller bindings.
• 🎛️
  VineJS validator integration Your request validators become OpenAPI request body and query parameter schemas. Zero duplication.
• 🖥️
  Swagger UI out of the box Interactive API explorer served directly from your AdonisJS app at /api/docs.
• 🔄
  Always in sync, never stale The spec is generated from your actual code. Update a model, the docs update automatically.
• ♾️
  Unlimited projects · All future updates One license for every AdonisJS project you build, now and in the future. No renewal, ever.

export default class PostsController {
  // Return type is all AdopenAPI needs
  async index(): Promise<Post[]> {
    return Post.query().preload('author')
  }
}

// → GET /posts → 200 application/json → Post[]
// → schema generated from Post model fields
// → served at /api/docs automatically