Security

You can define which security mechanisms should be used for your operations using the @ApiSecurity decorator.

app/controllers/users_controller.ts

import { ApiSecurity } from '@foadonis/openapi/decorators'
 
@ApiSecurity('basic')
export default class UsersController {}

The mechanisms must be define on your document, you can do this directly from your config/openapi.ts configuration file.

config/openapi.ts

import { defineConfig } from '@foadonis/openapi'
 
export default defineConfig({
  document: {
    components: {
      securitySchemes: {
        basic: {
          type: 'http',
          scheme: 'basic',
        },
      },
    },
  },
})

Examples

Basic authentication

app/controllers/users_controller.ts

import { ApiBasicAuth } from '@foadonis/openapi/decorators'
 
@ApiBasicAuth()
export default class UsersController {}

config/openapi.ts

import { defineConfig } from '@foadonis/openapi'
 
export default defineConfig({
  document: {
    components: {
      securitySchemes: {
        basic: {
          type: 'http',
          scheme: 'basic',
        },
      },
    },
  },
})

Bearer authentication

app/controllers/users_controller.ts

import { ApiBearerAuth } from '@foadonis/openapi/decorators'
 
@ApiBearerAuth()
export default class UsersController {}

config/openapi.ts

import { defineConfig } from '@foadonis/openapi'
 
export default defineConfig({
  document: {
    components: {
      securitySchemes: {
        bearer: {
          type: 'http',
          scheme: 'bearer',
          bearerFormat: 'JWT',
        },
      },
    },
  },
})

OAuth2 authentication

app/controllers/users_controller.ts

import { ApiOAuth2 } from '@foadonis/openapi/decorators'
 
@ApiOAuth2('users:read', 'global:read')
export default class UsersController {}

config/openapi.ts

import { defineConfig } from '@foadonis/openapi'
 
export default defineConfig({
  document: {
    components: {
      securitySchemes: {
        bearer: {
          type: 'oauth2',
          flows: {
            implicit: {
              authorizationUrl: 'https://example.com/api/oauth/dialog',
              scopes: {
                'users:read': 'read users',
                'global:read': 'global read',
              },
            },
          },
        },
      },
    },
  },
})

Examples

Basic authentication

Bearer authentication

OAuth2 authentication

On this page