Globals / fastifyOAS / FastifyOASOptions
Fastify OAS plugin options
-
RegisterOptions
↳ FastifyOASOptions
• Optional addModels: boolean
Defined in lib/index.d.ts:118
If true adds fastify schemas as openapi models
default false
• Optional exposeRoute: boolean | ExposeOptions
Defined in lib/index.d.ts:113
If true the plugin will expose the documentation routes
default false
• Optional hideUntagged: boolean
Defined in lib/index.d.ts:137
If true will not add routes without tags
default false
• Optional logLevel: LogLevel
Inherited from FastifyOASOptions.logLevel
Defined in node_modules/fastify/types/register.d.ts:6
• Optional logSerializers: Record<string, (value: any) => string>
Inherited from FastifyOASOptions.logSerializers
Defined in node_modules/fastify/types/register.d.ts:7
• Optional openapi: string
Defined in lib/index.d.ts:123
Openapi version
default 3.0.0
• Optional prefix: string
Inherited from FastifyOASOptions.prefix
Defined in node_modules/fastify/types/register.d.ts:5
• Optional routePrefix: string
Defined in lib/index.d.ts:108
Documentation endpoint
default /documentation
• Optional swagger: OpenApiSpec
Defined in lib/index.d.ts:132
OpenApi/Swagger object except paths
• Optional yaml: boolean
Defined in lib/index.d.ts:128
If true returns yaml instead of json
default false