schemas.md

Schemas

{% hint style="danger" %}

This page was deprecating! Please use Schemator middleware

{% endhint %}

Swagger documentation generated based on schemas

{% hint style="info" %} If you correctly and exactly define the schema, your app will be faster by 25-30% which is good and validation support will be out-of-the-box {% endhint %}

Validation

{% hint style="info" %} All validations are optional {% endhint %}

Types of validation

• headers
• params
• query
• body
• cookies

{% hint style="info" %} For more information, please look at Ajv docs {% endhint %}

{% hint style="info" %} If you don't want to use any or all (except body) of these validation method, please set it to false for performance reason {% endhint %}

app.get(
  '/',
  {
    schema: {
      headers: {
        type: 'object',
        properties: {
          authorization: { type: 'string' }
        }
      },
      query: false,
      params: false,
      cookies: false
    }
  },
  async () => ({ hello: 'world' })
);

app.listen(4000);

Serialization

Types of serialization

We use fast-json-stringify under the hood for serialization and improving response time (applies for Array and Object)

{% hint style="warning" %} If schema is wrong, error is not causing, it just removes that value from response which may be bad for your application, so, please be careful then typing schema {% endhint %}

{% hint style="info" %} If required property was used and value isn't returned, server may crash or performance may be dropped by 6-8 times, please, try to make sure everything is correct on your schema {% endhint %}

Response content types:

• response
• response.HTTP_CODE

app.get(
  '/',
  {
    schema: {
      response: {
        type: 'object',
        properties: {
          hello: { type: 'string' }
        }
      }
    }
  },
  async () => ({ hello: 'world' })
);

app.listen(4000);

HTTP Code-based serialization

app.get(
  '/',
  {
    schema: {
      response: {
        200: {
          type: 'object',
          properties: {
            hello: { type: 'string' }
          }
        },
        404: {
          type: 'object',
          properties: {
            status: { type: 'string' }
          }
        }
      }
    }
  },
  async () => ({ hello: 'world' })
);

app.listen(4000);