forked from BrasilAPI/BrasilAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfipe.json
More file actions
260 lines (260 loc) · 9.72 KB
/
Copy pathfipe.json
File metadata and controls
260 lines (260 loc) · 9.72 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
{
"tags": [
{
"name": "FIPE",
"description": "Informações sobre Preço Médio de Veículos fornecido pela FIPE (Fundação Instituto de Pesquisas Econômicas)"
}
],
"paths": {
"/fipe/marcas/v1/{tipoVeiculo}": {
"get": {
"tags": ["FIPE"],
"summary": "Lista as marcas de veículos referente ao tipo de veículo",
"description": "",
"parameters": [
{
"name": "tipoVeiculo",
"description": "Os tipos suportados são `caminhoes`, `carros` e `motos`. Quando o tipo não é específicado são buscada as marcas de todos os tipos de veículos\n",
"in": "path",
"required": false,
"schema": {
"type": "string",
"format": "string"
}
},
{
"name": "tabela_referencia",
"description": "Código da tabela fipe de referência. Por padrão é utilizado o código da tabela fipe atual.\n",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MarcaFIPE"
}
}
}
}
},
"400": {
"description": "Tabela de referência inválida",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": {
"message": "Tabela de referência inválida",
"type": "bad_request",
"name": "BadRequestError"
}
}
}
}
}
}
},
"/fipe/preco/v1/{codigoFipe}": {
"get": {
"tags": ["FIPE"],
"summary": "Consulta o preço do veículo segundo a tabela fipe.",
"description": "",
"parameters": [
{
"name": "codigoFipe",
"description": "Código fipe do veículo.\n",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "string"
}
},
{
"name": "tabela_referencia",
"description": "Código da tabela fipe de referência. Por padrão é utilizado o código da tabela fipe atual.\n",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VeiculoFIPE"
}
}
}
}
},
"400": {
"description": "Requisição inválida",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Código Fipe Inválido": {
"value": {
"message": "Código fipe inválido",
"type": "bad_request",
"name": "BadRequestError"
}
},
"Tabela FIPE Inválida": {
"value": {
"message": "Tabela FIPE Inválida",
"type": "bad_request",
"name": "BadRequestError"
}
}
}
}
}
}
}
}
},
"/fipe/tabelas/v1": {
"get": {
"tags": ["FIPE"],
"summary": "Lista as tabelas de referência existentes.",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TabelaFIPE"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"TabelaFIPE": {
"title": "Tabelas de referência FIPE",
"required": ["codigo", "mes"],
"type": "object",
"properties": {
"codigo": {
"type": "integer"
},
"mes": {
"type": "string"
}
},
"example": {
"codigo": 271,
"mes": "junho/2021 "
}
},
"MarcaFIPE": {
"title": "Marcas FIPE",
"required": ["nome", "valor"],
"type": "object",
"properties": {
"nome": {
"type": "string"
},
"valor": {
"type": "integer"
}
},
"example": {
"nome": "AGRALE",
"valor": "102"
}
},
"VeiculoFIPE": {
"title": "Veículo FIPE",
"required": [
"valor",
"marca",
"modelo",
"anoModelo",
"combustivel",
"codigoFipe",
"mesReferencia",
"tipoVeiculo",
"siglaCombustivel",
"dataConsulta"
],
"type": "object",
"properties": {
"valor": {
"type": "string"
},
"marca": {
"type": "string"
},
"modelo": {
"type": "string"
},
"anoModelo": {
"type": "integer"
},
"combustivel": {
"type": "string"
},
"codigoFipe": {
"type": "string"
},
"mesReferencia": {
"type": "string"
},
"tipoVeiculo": {
"type": "integer"
},
"siglaCombustivel": {
"type": "string"
},
"dataConsulta": {
"type": "string"
}
},
"example": {
"valor": "R$ 6.022,00",
"marca": "Fiat",
"modelo": "Palio EX 1.0 mpi 2p",
"anoModelo": 1998,
"combustivel": "Álcool",
"codigoFipe": "001004-9",
"mesReferencia": "junho de 2021 ",
"tipoVeiculo": 1,
"siglaCombustivel": "Á",
"dataConsulta": "segunda-feira, 7 de junho de 2021 23:05"
}
}
}
}
}