Scribd
Carregar
4 visualizações4 páginas

Exemplo de API OpenAPI 3.0 com JSON

O documento apresenta um exemplo de especificação OpenAPI 3.0 para uma API que lista produtos, incluindo detalhes sobre suas categorias e tags. A estrutura inclui objetos e arrays, com o modelo 'Produto' referenciando um objeto 'Fornecedor' e um objeto embutido para 'categoria'. Além disso, o 'Fornecedor' possui um objeto embutido chamado 'endereco'.

Enviado por

elton.barbosa.trader
Direitos autorais
© All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
4 visualizações4 páginas

Exemplo de API OpenAPI 3.0 com JSON

O documento apresenta um exemplo de especificação OpenAPI 3.0 para uma API que lista produtos, incluindo detalhes sobre suas categorias e tags. A estrutura inclui objetos e arrays, com o modelo 'Produto' referenciando um objeto 'Fornecedor' e um objeto embutido para 'categoria'. Além disso, o 'Fornecedor' possui um objeto embutido chamado 'endereco'.

Enviado por

elton.barbosa.trader
Direitos autorais
© All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd

✅ Exemplo Swagger OpenAPI 3.

0 – JSON com arrays


e objetos
json
CopiarEditar
{
"openapi": "3.0.3",
"info": {
"title": "API de Exemplo",
"description": "API de exemplo com arrays e objetos embutidos e
reutilizáveis.",
"version": "1.0.0",
"contact": {
"name": "Suporte da API",
"email": "suporte@[Link]"
}
},
"servers": [
{
"url": "[Link]
"description": "Servidor de produção"
}
],
"paths": {
"/produtos": {
"get": {
"summary": "Lista produtos",
"description": "Retorna todos os produtos com suas
categorias e tags.",
"responses": {
"200": {
"description": "Lista de produtos",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Produto"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Produto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"nome": {
"type": "string",
"example": "Camiseta"
},
"categoria": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 10
},
"nome": {
"type": "string",
"example": "Vestuário"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string",
"example": "promoção"
}
},
"fornecedor": {
"$ref": "#/components/schemas/Fornecedor"
}
}
},
"Fornecedor": {
"type": "object",
"properties": {
"nome": {
"type": "string",
"example": "Loja XYZ"
},
"cnpj": {
"type": "string",
"example": "12.345.678/0001-90"
},
"endereco": {
"type": "object",
"properties": {
"rua": {
"type": "string",
"example": "Rua A"
},
"numero": {
"type": "integer",
"example": 123
},
"cidade": {
"type": "string",
"example": "São Paulo"
}
}
}
}
}
}
}
}

🔍 Destaques do exemplo:
●​ Produto contém:​

○​ um objeto embutido (categoria);​

○​ um array de tags simples (strings);​

○​ um objeto reutilizável (fornecedor, definido em


[Link]);​

●​ Fornecedor contém:​

○​ um objeto embutido chamado endereco.

Você também pode gostar