adonis5-swagger
Version:
Swagger provider for AdonisJS 5
31 lines (26 loc) • 767 B
Plain Text
import { SwaggerConfig } from '@ioc:Adonis/Addons/Swagger'
export default {
uiEnabled: true, //disable or enable swaggerUi route
uiUrl: 'docs', // url path to swaggerUI
specEnabled: true, //disable or enable swagger.json route
specUrl: '/swagger.json',
middleware: [], // middlewares array, for protect your swagger docs and spec endpoints
options: {
definition: {
openapi: '3.0.0',
info: {
title: 'Application with swagger docs',
version: '1.0.0',
description: 'My application with swagger docs'
}
},
apis: [
'app/**/*.ts',
'docs/swagger/**/*.yml',
'start/routes.ts'
],
basePath: '/'
},
mode: process.env.NODE_ENV === 'production' ? 'PRODUCTION' : 'RUNTIME',
specFilePath: 'docs/swagger.json'
} as SwaggerConfig