Introduction

AdonisJS OpenAPI turns decorated controllers and models into an OpenAPI V3 specification, served through Scalar, Swagger UI or Rapidoc.

Build OpenAPI compliant APIs using AdonisJS.

import {  } from '@foadonis/openapi/decorators'

export default class  {
  @()
  declare : number

  @()
  declare : string

  @({ : false, :  })
  declare ?: string
}

Features

✔ OpenAPI V3 specifications
✔ Fully typesafe
✔ Automatically infer types
✔ Automatically loads your controller from Adonis Router
✔ Supports Scalar, Swagger UI and Rapidoc
✔ Supports schema generation from Luxon and VineJS

Getting Started

Decorate an AdonisJS controller and model with @foadonis/openapi, call registerRoutes(), then browse the generated specification on /api, /api.json or /api.yaml.

Introduction

Features

On this page