swagger-ajv-converter's Introduction

ajv-to-swagger

Convert schema from AJV to Swagger

That package converts ajv schemas (JSON schema draft 07) to Swagger schema (OpenApi 3).

All you need to do after conversion is to insert converted schema into corresponding place in swagger schema.

Install

npm i ajv-to-swagger

Usage

const convertor = require('ajv-to-swagger');

// some kind of AJV schema which we provide as a response
const ajvResponseSchema = {
  type: 'object',
  properties: {
    currency: { type: 'string', minLength: 3, maxLength: 3 },
    id: { type: 'string', minLength: 36, maxLength: 36 },
    version: { enum: [2] },
    rates: {
      type: 'object',
      example: {
        USDEUR: '0.881367883',
        USDRUB: '67.905200000'
        },
      patternProperties: {
        '^[A-Z]{6}$': { type: 'string' },
      },
      additionalProperties: false,
    },
  },
  additionalProperties: false,
};
  
// make a draft of your schema without a response schema:
const baseSchema = 
    {
      "openapi": "3.0.1",
      "info": {
        "title": "defaultTitle",
        "description": "defaultDescription",
        "version": "0.1"
      },
      "servers": [
        {
          "url": "https://google.com"
        }
      ],
      "paths": {
        "/get/some/": {
          "get": {
            "description": "Auto generated using Swagger Inspector",
            "parameters": [
              {
                "name": "cs",
                "in": "query",
                "schema": {
                  "type": "string"
                },
                "example": "E"
              }
            ],
            "responses": {
              "200": {
                "description": "Auto generated using Swagger Inspector",
                "content": {
                  "application/json": {
                    "schema": {}
                  }
                }
              }
            },
            "servers": [
              {
                "url": "https://google.com"
              }
            ]
          },
          "servers": [
            {
              "url": "https://google.com"
            }
          ]
        }
      }
    };

const responseSwagger = convertor.convertSchema(ajvResponseSchema);

// put your schema where it needs to be
baseSchema.paths['/get/some/'].get.responses['200'].content['application/json'].schema = responseSwagger.schema;