import { FastifyOpenAPI, OpenAPIPlugin } from '@kakang/fastify-openapi'fastify.register(FastifyOpenAPI, { // plugin plugins: [ OpenAPIPlugin ], // base document shared for multiple document // it should follow the format of OpenAPI 3.0 document: {}, // multi document customize property // it should follow the format of OpenAPI 3.0 documents: { // it use key-value, for the multi document default: {} }, // routes options for document and ui routes: { // prefix shared by all routes prefix: '/documentation', // config for each document documents: { // it use key-value, for the multi document default: { // ui path ui: '/', // document path document:
On Path hook is executed for generate OpenAPI OperationObject.
function plugin(instance) { /** * @param {DocumentGenerator} instance document generator * @param {RouteOptions|OperationObject} schema last hook result. If it is the first hook, it is the original schema. * @param {RouteOptions} originalSchema original schema * @param {object} additionalInformation additional information * @returns {OperationObject} operation object **/ instance.addHook('onPath', function(instance, schema, originalSchema, additionalInformation) { return schema })}
onQuery, onParam, onHeader, onCookie
On Query, Param, Header and Cookie hook are executed for generate OpenAPI ParameterObject.
function plugin(instance) { /** * @param {DocumentGenerator} instance document generator * @param {ParameterSchema|ParameterObject} schema last hook result. If it is the first hook, it is the original schema. * @param {ParameterSchema} originalSchema original schema * @param {object} additionalInformation additional information * @returns {ParameterObject} operation object **/ instance.addHook('onQuery', function(instance, schema, originalSchema, additionalInformation) { return schema }) instance.addHook('onParam', function(instance, schema, originalSchema, additionalInformation) { return schema
onBody
On Body hook is executed for generate OpenAPI RequestBodyObject.
function plugin(instance) { /** * @param {DocumentGenerator} instance document generator * @param {JSONSchema|RequestBodyObject} schema last hook result. If it is the first hook, it is the original schema. * @param {JSONSchema} originalSchema original schema * @param {object} additionalInformation additional information * @returns {RequestBodyObject} operation object **/ instance.addHook('onPath', function(instance, schema, originalSchema, additionalInformation) { return schema })}
onResponse
On Response hook is executed for generate OpenAPI ResponsesObject.
function plugin(instance) { /** * @param {DocumentGenerator} instance document generator * @param {JSONSchema|RequestBodyObject} schema last hook result. If it is the first hook, it is the original schema. * @param {JSONSchema} originalSchema original schema * @param {object} additionalInformation additional information * @returns {ResponsesObject} operation object **/ instance.addHook('onResponse', function(instance, schema, originalSchema, additionalInformation) { return schema })}
onTransform
On Transform hook is executed for generate valid schema.
function plugin(instance) { /** * @param {DocumentGenerator} instance document generator * @param {unknown} schema last hook result. If it is the first hook, it is the original schema. * @param {unknown} originalSchema original schema * @param {object} additionalInformation additional information * @returns {JSONSchema} operation object **/ instance.addHook('onTransform', function(instance, schema, originalSchema, additionalInformation) { return schema })}
'/openapi.json'
,
// ui route option
uiRouteOptions: {},
// document route option
documentRouteOptions: {}
}
}
},
// function to identify which document the route belong to