README.md

Swagger Validator

This repository provides a useful tool to validation of swagger. The main objective is validate the rules from Open Finance Brasil.

Just put in the payload the url and validators that you want to validate.

Setup project

npm install

Running locally:

npx ts-node index.ts

Executing

POST /validation

Request payload example:
{
  "url" : "https://raw.githubusercontent.com/Sensedia/draft-openapi/aggr-opendata-accounts/swagger-apis/opendata-accounts/1.0.0-beta.1.yml",
  "validators" : [1,2,3,4,5,6,7]

}

Validators

1 - String with property 'MaxLength'

2 - Enum without property 'MaxLength'

3 - String with property 'pattern' valid with property 'example'

4 - String with Pattern

5 - Array with 'MaxItem'

6 - String with property 'MinLength'

7 - Property 'pattern' without 'NA'

8 - String not accept text with trim on pattern

9 - Property in required without be used

10 - Property cnpj with pattern valid

11 - Property cpf with pattern valid

Output

   {
      "field": "accounts/get/responses/200/data/items/brandName",
      "rule": "Campo não contem propriedade 'minLength'"

    },
    {
      "field": "accounts/get/responses/200/data/items/brandName",
      "rule": "Campo contem propriedade 'pattern' igual [\\w\\w\\s]*"
    },
    {
      "field": "accounts/get/responses/200/data/items/companyCnpj",
      "rule": "Campo não contem propriedade 'minLength'"
    }