forked from AntonioMontanha/gerenciador-viagens
/
swaggerfile.yml
262 lines (261 loc) · 6.43 KB
/
swaggerfile.yml
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
261
262
swagger: "2.0"
info:
description: "Encontre aqui toda a documentação referente a API Gerenciador de Viagem de Antonio Montanha"
version: "1.0.0"
title: "Gerenciador de Viagens"
termsOfService: "https://github.com/AntonioMontanha/gerenciador-viagens"
contact:
email: "ammontanha@gmail.com"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "localhost:8089"
basePath: "/"
tags:
- name: "auth"
description: "Mecanismos de autenticação"
schemes:
- "http"
paths:
/api/auth:
post:
tags:
- "auth"
summary: "Logar como Usuário ou Administrador"
description: "Através deste endpoint podemos fazer login para capturar o token e utilizar a API"
operationId: "authenticacao"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Dados para fazer login"
required: true
schema:
$ref: "#/definitions/Auth"
responses:
200:
description: "Sucesso"
schema:
$ref: "#/definitions/AuthResponse"
/api/viagem:
post:
tags:
- "viagem"
summary: "Inserir uma nova viagem"
description: "Inserir uma nova viagem que será utilizada pelo sistema"
operationId: "post_viagem"
produces:
- "application/json"
parameters:
- name: "Authorization"
in: "header"
description: "Token para autenticação"
required: true
type: "string"
- name: "body"
in: "body"
description: "Dados para fazer login"
required: true
schema:
$ref: "#/definitions/Viagem"
responses:
201:
description: "Sucesso"
schema:
$ref: '#/definitions/ViagemResponse'
400:
description: "Erros de negócio"
schema:
$ref: '#/definitions/ErroResponse'
get:
tags:
- "viagem"
summary: "Procurar viagem"
description: "Retorna uma lista de viagem"
operationId: "getViagem"
produces:
- "application/json"
parameters:
- name: "Authorization"
in: "header"
description: "Token para autenticação"
required: true
type: "string"
- name: "localDeDestino"
in: query
description: "Filtro para busca de viagens por sua localização"
required: false
type: "string"
responses:
200:
description: "Sucesso"
schema:
$ref: "#/definitions/ListaViagemResponse"
/api/viagem/{viagemId}:
get:
tags:
- "viagem"
summary: "Procurar uma viagem pelo ID"
description: "Retorna uma única viagem"
operationId: "getViagemPeloID"
produces:
- "application/json"
parameters:
- name: "Authorization"
in: "header"
description: "Token para autenticação"
required: true
type: "string"
- name: "viagemId"
in: "path"
description: "ID de uma viagem"
required: true
type: "integer"
format: "int64"
responses:
200:
description: "Sucesso"
schema:
$ref: "#/definitions/ViagemResponse"
400:
description: "ID inválido"
404:
description: "Viagem não encontrada"
put:
tags:
- "viagem"
summary: "Alterar uma viagem"
description: "Alterar uma viagem"
operationId: "update_viagem"
produces:
- "application/json"
parameters:
- name: "Authorization"
in: "header"
description: "Token para autenticação"
required: true
type: "string"
- name: "viagemId"
in: "path"
description: "ID de uma viagem"
required: true
type: "integer"
format: "int64"
- name: "body"
in: "body"
description: "Dados para fazer login"
required: true
schema:
$ref: "#/definitions/Viagem"
responses:
200:
description: "Sucesso"
schema:
$ref: '#/definitions/ViagemResponse'
400:
description: "Erros de negócio"
schema:
$ref: '#/definitions/ErroResponse'
delete:
tags:
- "viagem"
summary: "Remover uma viagem pelo ID"
description: "Remove uma única viagem"
operationId: "deleteViagemPeloID"
produces:
- "application/json"
parameters:
- name: "Authorization"
in: "header"
description: "Token para autenticação"
required: true
type: "string"
- name: "viagemId"
in: "path"
description: "ID de uma viagem"
required: true
type: "integer"
format: "int64"
responses:
204:
description: "Sucesso"
400:
description: "ID inválido"
404:
description: "Viagem não encontrada"
definitions:
Auth:
type: "object"
properties:
email:
type: "string"
senha:
type: "string"
AuthResponse:
type: "object"
properties:
data:
type: "object"
properties:
token:
type: "string"
errors:
type: "array"
items: {}
Viagem:
type: "object"
properties:
localDeDestino:
type: "string"
dataPartida:
type: "string"
format: "full-date"
dataRetorno:
type: "string"
format: "full-date"
acompanhante:
type: "string"
regiao:
type: "string"
ViagemResponse:
type: "object"
properties:
data:
type: "object"
properties:
id:
type: "integer"
localDeDestino:
type: "string"
dataPartida:
type: "string"
format: "full-date"
dataRetorno:
type: "string"
format: "full-date"
acompanhante:
type: "string"
regiao:
type: "string"
temperatura:
type: "number"
errors:
type: "array"
items: {}
ListaViagemResponse:
type: "array"
items: {
$ref: "#/definitions/ViagemResponse"
}
ErroResponse:
type: "object"
properties:
data:
type: "object"
errors:
type: "array"
items: {}
externalDocs:
description: "Find out more about Swagger"
url: "http://swagger.io"