Configuration

Reference for config/openapi.ts in @foadonis/openapi: the ui renderer, document info metadata, custom type loaders and extra controller registration.

config/openapi.ts

import {  } from '@foadonis/openapi'

export default ({
  : 'scalar',

  : {
    : {
      : 'My API',
      : '1.0.0',
    },
  },

  : [MyCustomLoader],

  : [CustomController],
})

Typesafe Frontend

Feed the schema generated by AdonisJS OpenAPI to openapi-fetch or Hey API for fully typed frontend calls, with a comparison to help you pick one.

Decorators

Full decorator reference for @foadonis/openapi, from @ApiOperation and @ApiResponse through @ApiSecurity, @ApiExtraModels and @ApiHideProperty.