-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.http
More file actions
461 lines (316 loc) · 7.02 KB
/
Copy pathapi.http
File metadata and controls
461 lines (316 loc) · 7.02 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
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
### BookShelf API Testing
### Use with REST Client VS Code extension (humao.rest-client)
@baseUrl = http://localhost:5173/api
### ============================================
### AUTHENTICATION
### ============================================
### Login
POST {{baseUrl}}/auth/login
Content-Type: application/json
{
"email": "test@example.com",
"password": "password123"
}
###
### Get current user
GET {{baseUrl}}/auth/me
###
### Logout
POST {{baseUrl}}/auth/logout
### ============================================
### BOOKS
### ============================================
### List books (with pagination)
GET {{baseUrl}}/books?page=1&limit=24
###
### List books (with filters)
GET {{baseUrl}}/books?search=lord&status=1&genre=1&sort=title&order=asc
###
### Get book options (dropdowns)
GET {{baseUrl}}/books/options
###
### Get single book
GET {{baseUrl}}/books/1
###
### Create book
POST {{baseUrl}}/books
Content-Type: application/json
{
"title": "Test Book",
"statusId": 1,
"rating": 4,
"authors": [{ "id": 1, "role": "Author", "isPrimary": true }],
"series": [{ "id": 1, "bookNum": 1, "isPrimary": true }]
}
###
### Update book
PUT {{baseUrl}}/books/1
Content-Type: application/json
{
"title": "Updated Title",
"rating": 5
}
###
### Delete book
DELETE {{baseUrl}}/books/1
###
### Book lookup by ISBN
GET {{baseUrl}}/books/lookup?isbn=9780544003415
###
### Book lookup by title
GET {{baseUrl}}/books/lookup?query=the hobbit
### ============================================
### AUTHORS
### ============================================
### List authors
GET {{baseUrl}}/authors?page=1&limit=24
###
### Search authors
GET {{baseUrl}}/authors?search=tolkien
###
### Get author with books
GET {{baseUrl}}/authors/1
###
### Create author
POST {{baseUrl}}/authors
Content-Type: application/json
{
"name": "New Author",
"bio": "Author biography"
}
###
### Update author
PUT {{baseUrl}}/authors/1
Content-Type: application/json
{
"name": "Updated Author Name"
}
###
### Delete author
DELETE {{baseUrl}}/authors/1
### ============================================
### SERIES
### ============================================
### List series
GET {{baseUrl}}/series?page=1&limit=24
###
### Search series
GET {{baseUrl}}/series?search=rings
###
### Get series with books
GET {{baseUrl}}/series/1
###
### Create series
POST {{baseUrl}}/series
Content-Type: application/json
{
"title": "New Series"
}
###
### Update series
PUT {{baseUrl}}/series/1
Content-Type: application/json
{
"title": "Updated Series Title"
}
###
### Delete series
DELETE {{baseUrl}}/series/1
### ============================================
### TAGS
### ============================================
### List tags
GET {{baseUrl}}/tags?page=1&limit=50
###
### Get tag with books
GET {{baseUrl}}/tags/1
###
### Create tag
POST {{baseUrl}}/tags
Content-Type: application/json
{
"name": "New Tag",
"color": "#3b82f6"
}
###
### Quick create tag
POST {{baseUrl}}/tags/quick
Content-Type: application/json
{
"name": "Quick Tag"
}
###
### Toggle tag on book
POST {{baseUrl}}/tags/toggle
Content-Type: application/json
{
"tagId": 1,
"bookId": 1
}
###
### Update tag
PUT {{baseUrl}}/tags/1
Content-Type: application/json
{
"name": "Updated Tag",
"color": "#ef4444"
}
###
### Delete tag
DELETE {{baseUrl}}/tags/1
### ============================================
### GENRES
### ============================================
### List genres
GET {{baseUrl}}/genres?page=1&limit=50
###
### Get genre with books
GET {{baseUrl}}/genres/1
###
### Create genre
POST {{baseUrl}}/genres
Content-Type: application/json
{
"name": "New Genre",
"color": "#22c55e",
"icon": "book"
}
###
### Update genre
PUT {{baseUrl}}/genres/1
Content-Type: application/json
{
"name": "Updated Genre"
}
###
### Delete genre
DELETE {{baseUrl}}/genres/1
### ============================================
### FORMATS
### ============================================
### List formats
GET {{baseUrl}}/formats?page=1&limit=50
###
### Get format with books
GET {{baseUrl}}/formats/1
###
### Create format
POST {{baseUrl}}/formats
Content-Type: application/json
{
"name": "New Format"
}
###
### Update format
PUT {{baseUrl}}/formats/1
Content-Type: application/json
{
"name": "Updated Format"
}
###
### Delete format
DELETE {{baseUrl}}/formats/1
### ============================================
### NARRATORS
### ============================================
### List narrators
GET {{baseUrl}}/narrators?page=1&limit=50
###
### Get narrator with books
GET {{baseUrl}}/narrators/1
###
### Create narrator
POST {{baseUrl}}/narrators
Content-Type: application/json
{
"name": "New Narrator",
"bio": "Narrator biography"
}
###
### Update narrator
PUT {{baseUrl}}/narrators/1
Content-Type: application/json
{
"name": "Updated Narrator"
}
###
### Delete narrator
DELETE {{baseUrl}}/narrators/1
### ============================================
### STATUSES
### ============================================
### List statuses (system-defined)
GET {{baseUrl}}/statuses
###
### Get status with books
GET {{baseUrl}}/statuses/1
###
### Update status name (localization)
PUT {{baseUrl}}/statuses/1
Content-Type: application/json
{
"name": "Gelesen"
}
### ============================================
### EBOOKS
### ============================================
### Get reading progress
GET {{baseUrl}}/ebooks/1/progress
###
### Save reading progress
POST {{baseUrl}}/ebooks/1/progress
Content-Type: application/json
{
"location": "epubcfi(/6/4!/4/2/1:0)",
"percentage": 25.5
}
###
### Delete ebook from book
DELETE {{baseUrl}}/ebooks/1
### ============================================
### COVERS
### ============================================
### Download cover from URL
POST {{baseUrl}}/covers/download
Content-Type: application/json
{
"url": "https://covers.openlibrary.org/b/isbn/9780544003415-L.jpg",
"bookId": 1
}
### ============================================
### SEARCH
### ============================================
### Autocomplete search
GET {{baseUrl}}/search/autocomplete?q=lord
### ============================================
### IMPORT
### ============================================
### Book lookup by ISBN (for import)
GET {{baseUrl}}/import/lookup?isbn=9780544003415
###
### Book lookup by title (for import)
GET {{baseUrl}}/import/lookup?query=the hobbit
###
### Get full details for a lookup result
POST {{baseUrl}}/import/lookup
Content-Type: application/json
{
"source": "openlibrary",
"id": "OL27448W"
}
### Note: CSV and Audible imports require file uploads
### Use the web UI at /import for those
### ============================================
### EXPORT
### ============================================
### Export to CSV (full format)
GET {{baseUrl}}/export?format=csv
###
### Export to CSV (Goodreads compatible)
GET {{baseUrl}}/export?format=csv&goodreads=true
###
### Export to JSON (full backup)
GET {{baseUrl}}/export?format=json
###
### Export JSON without authors/series
GET {{baseUrl}}/export?format=json&authors=false&series=false