java-spring-rest-api-project/swagger.yaml at main · juliocesarscheidt/java-spring-rest-api-project · GitHub

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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
swagger: '2.0'
info:
  description: Description
  version: v1
  title: Restful API with Spring Boot
  termsOfService: terms Of Service Url
  contact:
    name: Julio Cesar
    email: julio@blackdevs.com.br
basePath: /
tags:
  - name: Auth
    description: Auth Resource
  - name: Book
    description: Book Resource
  - name: Customer
    description: Customer Resource
paths:
  /v1/auth/signin:
    post:
      tags:
        - Auth
      summary: Signin
      operationId: signinUsingPOST
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: data
          description: data
          required: true
          schema:
            $ref: '#/definitions/AccountCredentialsDTO'
      responses:
        '200':
          description: OK
          schema:
            type: object
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v1/book:
    get:
      tags:
        - Book
      summary: Find All
      operationId: findUsingGET
      produces:
        - application/json
      parameters:
        - name: page
          in: query
          description: page
          required: false
          type: integer
          default: 0
          format: int32
        - name: size
          in: query
          description: size
          required: false
          type: integer
          default: 50
          format: int32
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/BookDTORes'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
        - Book
      summary: Create
      operationId: createUsingPOST
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: book
          description: book
          required: true
          schema:
            $ref: '#/definitions/BookDTOReq'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/BookDTORes'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v1/book/{id}:
    get:
      tags:
        - Book
      summary: Find One
      operationId: findOneUsingGET
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/BookDTORes'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
        - Book
      summary: Update
      operationId: updateUsingPUT
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: book
          description: book
          required: true
          schema:
            $ref: '#/definitions/BookDTOReq'
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int64
      responses:
        '201':
          description: Created
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/BookDTORes'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    delete:
      tags:
        - Book
      summary: Delete
      operationId: deleteUsingDELETE
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
          schema:
            type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /v1/customer:
    get:
      tags:
        - Customer
      summary: Find All
      operationId: findUsingGET_1
      produces:
        - application/json
      parameters:
        - name: page
          in: query
          description: page
          required: false
          type: integer
          default: 0
          format: int32
        - name: size
          in: query
          description: size
          required: false
          type: integer
          default: 50
          format: int32
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/CustomerDTORes'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
        - Customer
      summary: Create
      operationId: createUsingPOST_1
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: customer
          description: customer
          required: true
          schema:
            $ref: '#/definitions/CustomerDTOReq'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/CustomerDTORes'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v1/customer/{id}:
    get:
      tags:
        - Customer
      summary: Find One
      operationId: findOneUsingGET_1
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CustomerDTORes'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
        - Customer
      summary: Update
      operationId: updateUsingPUT_1
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: customer
          description: customer
          required: true
          schema:
            $ref: '#/definitions/CustomerDTOReq'
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int64
      responses:
        '201':
          description: Created
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/CustomerDTORes'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    delete:
      tags:
        - Customer
      summary: Delete
      operationId: deleteUsingDELETE_1
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
          schema:
            type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /v1/customer/{id}/disable:
    patch:
      tags:
        - Customer
      summary: Disable
      operationId: disableUsingPATCH
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
          schema:
            type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /v1/customer/{id}/enable:
    patch:
      tags:
        - Customer
      summary: Enable
      operationId: enableUsingPATCH
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: id
          required: true
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
          schema:
            type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
definitions:
  AccountCredentialsDTO:
    type: object
    properties:
      password:
        type: string
      username:
        type: string
    title: AccountCredentialsDTO
  BookDTOReq:
    type: object
    properties:
      author:
        type: string
      created_at:
        $ref: '#/definitions/TimestampReq'
      deleted_at:
        $ref: '#/definitions/TimestampReq'
      id:
        type: integer
        format: int64
      launch_date:
        type: string
        format: date-time
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      price:
        type: number
        format: double
      title:
        type: string
      updated_at:
        $ref: '#/definitions/TimestampReq'
    title: BookDTOReq
  BookDTORes:
    type: object
    properties:
      author:
        type: string
      created_at:
        $ref: '#/definitions/TimestampRes'
      deleted_at:
        $ref: '#/definitions/TimestampRes'
      id:
        type: integer
        format: int64
      launch_date:
        type: string
        format: date-time
      links:
        $ref: '#/definitions/Links'
      price:
        type: number
        format: double
      title:
        type: string
      updated_at:
        $ref: '#/definitions/TimestampRes'
    title: BookDTORes
  CustomerDTOReq:
    type: object
    properties:
      address:
        type: string
      created_at:
        $ref: '#/definitions/TimestampReq'
      deleted_at:
        $ref: '#/definitions/TimestampReq'
      email:
        type: string
      enabled:
        type: boolean
      first_name:
        type: string
      gender:
        type: string
      id:
        type: integer
        format: int64
      last_name:
        type: string
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      updated_at:
        $ref: '#/definitions/TimestampReq'
    title: CustomerDTOReq
  CustomerDTORes:
    type: object
    properties:
      address:
        type: string
      created_at:
        $ref: '#/definitions/TimestampRes'
      deleted_at:
        $ref: '#/definitions/TimestampRes'
      email:
        type: string
      enabled:
        type: boolean
      first_name:
        type: string
      gender:
        type: string
      id:
        type: integer
        format: int64
      last_name:
        type: string
      links:
        $ref: '#/definitions/Links'
      updated_at:
        $ref: '#/definitions/TimestampRes'
    title: CustomerDTORes
  Link:
    type: object
    properties:
      deprecation:
        type: string
      href:
        type: string
      hreflang:
        type: string
      media:
        type: string
      name:
        type: string
      profile:
        type: string
      rel:
        $ref: '#/definitions/LinkRelation'
      title:
        type: string
      type:
        type: string
    title: Link
  LinkRelation:
    type: object
    title: LinkRelation
  Links:
    type: object
    properties:
      empty:
        type: boolean
    title: Links
  TimestampReq:
    type: string
    format: date-time
    example: "2021-01-01T00:00:00.000Z"
    title: TimestampReq
  TimestampRes:
    type: string
    format: date-time
    example: "2021-01-01T00:00:00.000Z"
    title: TimestampRes