Campos de uma API JSON pela especificação OpenAPI (Swagger)

Quando a API do parceiro publica a especificação OpenAPI (Swagger 2.0 ou OpenAPI 3.x, em JSON), o Lefia lê os campos dela em vez de amostrar uma resposta. É o caminho certo para o destino que recebe POST (cadastro de fornecedor, produto, venda): não há resposta de onde tirar o corpo que ele espera.

Passo a passo

1. Na integração, abra a conexão REST de destino e clique em Detectar campos.
2. Em Ou ler da especificação OpenAPI (Swagger), cole a URL do swagger.json ou o próprio JSON e clique em Ler.
3. Escolha a operação (ex.: POST /api/v2/fornecedor). A lista traz só as operações que carregam um objeto: o corpo enviado, ou a resposta quando a operação não tem corpo (como a consulta da fila).
4. Confira os campos, o código sugerido (vem do caminho da operação) e o nome, e clique em Registrar no catálogo.

O que vem da especificação

• Tipo, obrigatoriedade, tamanho máximo, padrão e lista de valores de cada campo, com a descrição.
• Objetos aninhados viram caminhos com ponto (cliente.cnpj) e listas viram coleções (vendas[].produto), inclusive lista de valores simples (gtins[]).
• Partes reaproveitadas ($ref, allOf) são juntadas; alternativas (oneOf/anyOf) entram com todos os campos opcionais.

Corpo em lista

Quando a operação recebe uma lista de registros (o corpo é um array), a mensagem do catálogo é o registro, e ao registrar a conexão de destino passa a enviar o lote como array JSON. A tela avisa antes.

A especificação em YAML não é lida: exporte em JSON.