Skip to main content

Headers

export default {
  ...,
  generators: [
    {
      preset: 'headers',
      outputPath: './src/headers',
      serializationType: 'json', 
      language: 'typescript',
    }
  ]
};

headers preset is for generating models that represent typed models representing headers.

This is supported through the following inputs: asyncapi, openapi

It supports the following languages; typescript

Inputs​

asyncapi​

The headers preset with asyncapi input generates all the message headers for each channel in the AsyncAPI document.

The return type is a map of channels and the model that represent the headers.

openapi​

The headers preset with openapi input generates all the headers for each path in the OpenAPI document.

The return type is a map of paths and the model that represent the headers.

Typescript​

Dependencies:

  • If validation enabled, ajv: ^8.17.1

Validation​

Each generated class includes built-in JSON Schema validation capabilities through two static methods:

  • validate: Validates headers against the schema. Use this method when you want to validate data.
// Example
const result = UserSignedUpHeaders.validate({ data: headers });
if (!result.valid) {
  console.error('Validation errors:', result.errors);
}
  • createValidator: Creates a reusable validator function. Use this when you need to validate multiple instances of the same type and want to avoid recreating the validator each time.
// Example
const validator = UserSignedUpHeaders.createValidator();
const result = UserSignedUpHeaders.validate({ data: headers, ajvValidatorFunction: validator });
if (!result.valid) {
  console.error('Validation errors:', result.errors);
}

Both methods support custom Ajv instances and options for advanced validation scenarios.