Páginas filhas
  • Validador Automatizado de APIs: Validações realizadas e formas de correção

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

OpenAPI:

Filename:

should start with uppercase letter

should contain version (lowercase 'v')

Content Format:

shouldn't contain weird special characteres

should be complient with OpenAPI in version 3.0'

Servers:

should have a 'servers' property with 'URL' and 'variables'

should have an URL consistent with our model

Version:

should contain the same version on 'info' as in filename

Endpoints:

shouldn't contain 'post', 'put', 'get' or 'delete' in the URL

should contain success responses for all http verbs

...

should have unique 'operationId'

Schemas:

shouldn't contain 'schemas' definition inside this file

...

shouldn't have 'hasNext' when it's an 'getOne' endpoint

Parameters:

should have 'page', 'pagesize' and 'order' for collection endpoints

should use common parameters

...

should be 'required=true' when final path param

Errors:

should use common errors schema

xtotvs:

paths:

should contain xtotvs/productinformation as an array inside 'paths'

...