Introduction

Generate OpenAPI compliant specifications powered by openapi-metadata for you Adonis Application.

import { ApiProperty } from '@foadonis/openapi/decorators'
 
export default class Post {
  @ApiProperty()
  declare id: number
 
  @ApiProperty()
  declare title: string
 
  @ApiProperty({ required: false, type: String })
  declare content?: 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