-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
337 lines (330 loc) · 8.55 KB
/
swagger.yaml
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
---
swagger: "2.0"
info:
description: Simple REST API to keep track of my books
version: 1.0.0
title: Library API
contact:
email: wmsam91@gmail.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
host: api.wmsam.dev
basePath: /
tags:
- name: Book
description: API to return details of a single book
- name: Library
description: API to get/update book status from library
- name: Healthcheck
description: Healthcheck endpoint
schemes:
- https
paths:
/library/ping:
get:
tags:
- Healthcheck
summary: Returns current state of API
produces:
- application/json
responses:
200:
description: successful operation
schema:
$ref: "#/definitions/HealthcheckResponse"
/library/{userID}/book/{isbn}:
get:
tags:
- Library
summary: Get single book status from library
consumes:
- application/json
produces:
- application/json
parameters:
- name: userID
in: path
description: user identification string
required: true
type: string
- name: isbn
in: path
description: id string of book
required: true
type: string
responses:
200:
description: successful operation
schema:
$ref: "#/definitions/GetBookResponse"
500:
description: internal server error
schema:
$ref: "#/definitions/ErrorResponse"
/library/{userID}/books:
get:
tags:
- Library
summary: Get list of books from library under the same userID
consumes:
- application/json
produces:
- application/json
parameters:
- name: userID
in: path
description: user identification string
required: true
type: string
responses:
200:
description: successful operation
schema:
$ref: "#/definitions/ListBookResponse"
500:
description: internal server error
schema:
$ref: "#/definitions/ErrorResponse"
/library/{userID}/book:
post:
tags:
- Library
summary: Updates the book record if exists, creates a new record of said book if record does not exist in library
consumes:
- application/x-www-form-urlencoded
produces:
- application/json
parameters:
- name: userID
in: path
description: user identification string
required: true
type: string
- name: isbn
in: formData
description: isbn string of the book
required: true
type: string
- name: title
in: formData
description: title of the book
required: true
type: string
- name: author
in: formData
description: author of the book
required: true
type: string
- name: imageUrl
in: formData
description: image url string of the book
required: true
type: string
- name: smallImageUrl
in: formData
description: small image url string of the book
required: true
type: string
- name: publicationYear
in: formData
description: publication year string of the book
required: true
type: string
- name: averageRating
in: formData
description: average rating of the book
required: true
type: number
- name: status
in: formData
description: status of the book
required: true
type: number
- name: publisher
in: formData
description: publisher of the book
required: true
type: string
- name: escription
in: formData
description: description of the book
required: true
type: string
- name: categories
in: formData
description: categories of the book
required: true
type: string
- name: language
in: formData
description: language of the book
required: true
type: string
- name: source
in: formData
description: source of the book
required: true
type: string
- name: pageCount
in: formData
description: pageCount of the book
required: true
type: number
responses:
200:
description: successful operation
schema:
$ref: "#/definitions/GetBookResponse"
500:
description: internal server error
schema:
$ref: "#/definitions/ErrorResponse"
/book/{isbn}:
get:
tags:
- Book
summary: Gets the detail of a single book
consumes:
- application/json
produces:
- application/json
parameters:
- name: isbn
in: path
description: ID of book to return
required: true
type: string
responses:
200:
description: successful operation
schema:
$ref: "#/definitions/GetBookResponse"
500:
description: internal server error
schema:
$ref: "#/definitions/ErrorResponse"
400:
description: bad request
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: book not found
schema:
$ref: "#/definitions/ErrorResponse"
definitions:
HealthcheckResponse:
type: string
example: Pong
GetBookResponse:
type: object
properties:
isbn:
type: string
title:
type: string
author:
type: string
smallImageUrl:
type: string
imageUrl:
type: string
publisher:
type: string
description:
type: string
pageCount:
type: integer
format: int64
categories:
type: string
language:
type: string
publicationYear:
type: string
userID:
type: string
status:
type: integer
format: int64
source:
type: string
example:
isbn: 9781472223630
title: Roses Are Red (Alex Cross, #6)
author: James Patterson
imageUrl: https://i.gr-assets.com/images/S/compressed.photo.goodreads.com/books/1434737448l/25756904._SX98_.jpg
smallImageUrl: https://i.gr-assets.com/images/S/compressed.photo.goodreads.com/books/1434737448l/25756904._SX98_.jpg
publisher: headline
description: Alex Cross series book 6
pageCount: 435
categories: crime, thriller
publicationYear: 9999
status: 1
source: goodreads
ErrorResponse:
type: object
properties:
requestID:
type: string
message:
type: string
example:
- requestID: 827222ab-8e3c-44cf-b524-b4acc97d7016
message: "detailed error message"
ListBookResponse:
type: array
items:
type: object
properties:
isbn:
type: string
title:
type: string
author:
type: string
smallImageUrl:
type: string
imageUrl:
type: string
publisher:
type: string
description:
type: string
pageCount:
type: integer
format: int64
categories:
type: string
language:
type: string
publicationYear:
type: string
userID:
type: string
status:
type: integer
format: int64
source:
type: string
example:
- isbn: 9781472223630
title: Roses Are Red (Alex Cross, #6)
author: James Patterson
imageUrl: https://i.gr-assets.com/images/S/compressed.photo.goodreads.com/books/1434737448l/25756904._SX98_.jpg
publisher: headline
description: Alex Cross series book 6
pageCount: 435
categories: crime, thriller
publicationYear: 9999
status: 1
source: goodreads
- isbn: 9780751562774
title: The Secrets She Keeps
author: Michael Robotham
imageUrl: https://s.gr-assets.com/assets/nophoto/book/111x148-bcc042a9c91a29c1d680899eff700a03.png
status: 1
source: goodreads
externalDocs:
description: Find out more about Swagger
url: http://swagger.io