Types and parameters

Classes as schemas

One of the most powerful feature of this library is the ability to use classes as schemas. When using the @ApiProperty decorator it will automatically add the property to the generated schema and try to infer the type from your Typescript type.

app/schemas/post.ts

import { ApiProperty } from '@foadonis/openapi/decorators'
 
export class Post {
  @ApiProperty()
  declare id: number
 
  @ApiProperty()
  declare title: string
}

Advanced properties options

The @ApiProperty decorator also accepts the same properties as the original OpenAPI Schema object, allowing you to extend the generated schema.

app/schemas/post.ts

import { ApiProperty } from '@foadonis/openapi/decorators'
 
export class Post {
  @ApiProperty({
    example: 17,
  })
  declare id: number
 
  @ApiProperty({
    minLength: 6,
    maxLength: 255,
    example: 'How to create REST APIs with Adonis',
  })
  declare title: string
}

Optional properties

Due to the lack of informations provided by the Typescript metadata it is not possible to infer if a property is optional. For this you can either use the required option or the @ApiOptionalProperty decorator.

app/schemas/post.ts

import { ApiProperty, ApiPropertyOptional } from '@foadonis/openapi/decorators'
 
export class Post {
  @ApiProperty()
  declare id: number
 
  @ApiProperty()
  declare title: string
 
  @ApiPropertyOptional({ type: String }) 
  declare content?: string
 
  @ApiProperty({ type: String, required: false }) 
  declare description?: string
}

Explicit type

Sometimes the type of your property is too complex to be automatically inferred or might be serialized in a specific way. When it is the case, you should see a warning in the console. To resolve this, you simply have to define explicitly the type using the type option.

app/schemas/post.ts

import { ApiProperty } from '@foadonis/openapi/decorators'
 
export class Post {
  @ApiProperty({ type: CustomSchema }) 
  customData: any
}

You can create custom type loaders to automatically generate schemas for inferred custom types, more information on the openapi-metadata documentation.

Circular dependencies

You may have circular dependencies in your schema, for example a Post can have a Post as a parent. In this situation, you must explicitly define the type using a Thunk:

app/schemas/post.ts

import { ApiProperty } from '@foadonis/openapi/decorators'
 
export class Post {
  @ApiProperty({ type: () => Post })
  declare parent: Post
}

Primitives

Primitives can be defined by using their name as a string or its constructor.

import { ApiResponse, ApiProperty, ApiBody } from '@foadonis/openapi/decorators'
 
@ApiResponse({ type: 'string' })
@ApiProperty({ type: Number })
@ApiBody({ type: Boolean })

Arrays

You can configure a type to be an array by simply wrapping your base type in an array.

import { ApiProperty, ApiBody } from '@foadonis/openapi/decorators'
 
@ApiProperty({ type: [Post] })
@ApiBody({ type: [User] })

Raw schema

Sometimes you may want to define a raw OpenAPI schema. For this you can use the schema option.

import { ApiProperty } from '@foadonis/openapi/decorators'
import { getSchemaPath } from '@foadonis/openapi'
 
@ApiProperty({
  schema: {
    type: 'object',
    properties: {
      user: {
        $ref: getSchemaPath(User)
      }
    }
  }
})

Enums

An enum type can be defined by providing an array of the available items or a Typescript enum.

import { ApiQuery } from '@foadonis/openapi/decorators'
 
@ApiQuery({ name: "api", enum: ["openapi", "graphql"] })

import { ApiQuery } from '@foadonis/openapi/decorators'
 
enum ApiEnum {
  GRAPHQL = "graphql",
  OPENAPI = "openapi"
}
 
@ApiQuery({ name: "api", enum: ApiEnum })

Types and parameters

On this page