-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
1297 lines (1266 loc) · 64.9 KB
/
openapi.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
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
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: RecipeWebApp
version: '1.0'
servers:
- url: http://localhost:5252
paths:
/categories:
get:
tags:
- Category
summary: Отримання списку усіх категорій
description: Цей ендпоінт обробляє HTTP GET-запит для отримання списку усіх категорій.
responses:
'200':
description: Список усіх категорій отриманий успішно.
content:
application/json:
example:
- id: 2,
name: Другі страви
parentCategoryId: null
recipeCount: 3
subcategories: []
- id: 3
name: Страви з м'яса
parentCategoryId: 2
recipeCount: 3
subcategories: []
- id: 4
name: Перші страви
parentCategoryId: null
recipeCount: 5
subcategories: []
security: []
/categories/main:
get:
tags:
- Category
summary: Отримання списку "Головних" категорій
description: Цей ендпоінт обробляє HTTP GET-запит для отримання списку "Головних" категорій.
Головні категорія - це категорії які на вершині дерева категорій. Вони не мають батьківської категорії.
responses:
'200':
description: Список "Головних" категорій отриманий успішно.
content:
application/json:
example:
- id: 1
name: Другі страви
parentCategoryId: null
recipeCount: 7
subcategories: []
- id: 2
name: Салати
parentCategoryId: null
recipeCount: 3
subcategories: []
- id: 3
name: Перші страви
parentCategoryId: null
recipeCount: 5
subcategories: []
security: []
/categories/{id}:
get:
tags:
- Category
summary: Отримання інформації про категорію, дочірні категорії та рецепти
description: |
Обробляє HTTP GET-запит для отримання інформації, що є у категорії: дочірні категорії та рецепти з усіх них.
parameters:
- name: id
in: path
required: true
style: simple
description: Ідентифікатор категорії.
schema:
type: integer
format: int32
responses:
'200':
description: Успішно отримано інформацію про категорію, дочірні категорії та рецепти.
content:
application/json:
example:
category:
id: 1
name: Перші страви
recipeCount: 3
subcategories:
- id: 7
name: Гарячі супи
recipeCount: 2
subcategories: []
parentCategoryId: 1
- id: 8
name: Холодні супи
recipeCount: 1
subcategories: []
parentCategoryId: 1
- id: 9
name: Бульйони
recipeCount: 0
subcategories: []
parentCategoryId: 1
parentCategoryId: null
recipes:
- id: 5
name: Розсольник
description: |-
Розсольник по-домашньому – поживна перша страва, рецепт якої заснований на солоних огірках або огірковому розсолі. Цікаво, що раніше розсолом називали пиріг з куркою, гречаною кашею та порізаними вареними яйцями, а в начинку підливали розсіл. Цей рецепт розсольнику навіть згадував Гоголь у «Мертвих душах». Рецепт супу розсольник з’явився згодом – на огірковому розсолі, лимонному соку або капустяному розсолі.
Спочатку спробуємо, як приготувати розсольник з огірками за класичним рецептом з перловкою, а тоді вже будемо знати, як правильно варити розсольник з рисом і м’ясом або розсольник з грибами та перловкою. Цікаво буде спробувати інші варіанти: вегетаріанський розсольник – пісний рецепт, розсольник в мультиварці, розсольник з рибою, розсольник з фрикадельками. Смачний виходить розсольник за рецептом приготування з куркою та пшоном або гречкою.
photoName: d2763a20-870e-4e74-8a46-928cf83b58bbrozsolnyk-1024x683.jpg
difficulty: Легко
views: 46
cookingTime: '01:20:00'
ingredients: []
cookingSteps: []
comments:
- id: 3
userName: Валентина
title: Суп неймовірно смачнючий!!! Рекомендую всім)
createTime: '2024-01-11T17:19:16.0210087'
countOfLikes: 0
rating: 5
recipeId: 5
createDate: '2024-01-11T17:11:42.3669228'
user: null
userId: 1
category:
id: 7
name: Гарячі супи
recipeCount: 2
subcategories: []
parentCategoryId: 1
categoryId: 7
- id: 6
name: Суп харчо
description: |-
У різних областях Грузії готують суп харчо по-різному. Ми представляємо класичний грузинський рецепт супу харчо українською зі звичних для нашого столу інгредієнтів. Можна використовувати яловичину, якщо хочете суп харчо нежирний, баранину – харчо буде більш поживним та калорійним.
Помідори у рецепті супу харчо додають необхідну кислість замість аличі. Або можна використовувати чорнослив чи гранатовий сік. І не варто забувати головний секрет, як приготувати суп харчо в домашніх умовах – пряних спецій і зелені не шкодувати.
photoName: dfca8d85-b658-45fd-9cb1-62867d3357b4kharcho-1024x683.jpg
difficulty: Складно
views: 67
cookingTime: '01:50:00'
ingredients: []
cookingSteps: []
comments: []
createDate: '2024-01-11T18:41:35.4600151'
user: null
userId: 1
category:
id: 7
name: Гарячі супи
recipeCount: 2
subcategories: []
parentCategoryId: 1
categoryId: 7
- id: 7
name: Окрошка
description: 'За класичним рецептом окрошку приготувати просто: накришити різні овочі, додати зелень і заправити квасом. Але сьогодні ж виявляється, до складу окрошки часто входять абсолютно нестандартні продукти. Не тільки зі ковбасою, а й з різним м''ясом, рибою, крабовими паличками та морепродуктами, сиром і грибами. Якщо хочеться вже зовсім чогось екзотичного, то окрошку можна заправити світлим пивом, сироваткою, бульйоном, розсолом або томатною пастою.'
photoName: c662b22b-88f3-4fd5-bc40-c252049b8fccokroshka-768x512.jpg
difficulty: Легко
views: 33
cookingTime: '00:30:00'
ingredients: []
cookingSteps: []
comments:
- id: 8
userName: Степан
title: Ну на любителя
createTime: '2024-01-12T14:09:08.7519678'
countOfLikes: 0
rating: 3
recipeId: 7
- id: 9
userName: Тарас
title: Це взагалі російська кухня:( Навіть не буду куштувати!
createTime: '2024-01-12T14:09:34.7749952'
countOfLikes: 0
rating: 2
recipeId: 7
createDate: '2024-01-11T19:00:41.1732152'
user: null
userId: 1
category:
id: 8
name: Холодні супи
recipeCount: 1
subcategories: []
parentCategoryId: 1
categoryId: 8
'404':
description: Категорію не знайдено.
security: []
/categories/last:
get:
tags:
- Category
summary: Отримання списку "Останніх" категорій
description: Обробляє HTTP GET-запит для отримання списоку категорій, які є найнижчими у дереві категорій. Саме вони призначенні для того, щоб містити рецепти.
responses:
'200':
description: Успішне отримання списку категорій, які без дочірніх категорій.
content:
application/json:
example:
- id: 10
name: Страви з м'яса
recipeCount: 0
subcategories: []
parentCategoryId: 2
- id: 11
name: Страви з риби
recipeCount: 0
subcategories: []
parentCategoryId: 2
- id: 14
name: Гарнір
recipeCount: 0
subcategories: []
parentCategoryId: 2
- id: 7
name: Гарячі супи
recipeCount: 0
subcategories: []
parentCategoryId: 1
security: []
/:
get:
tags:
- Page
summary: Отримання головної сторінки.
description: Обробляє HTTP GET-запит для отримання головної сторінки.
responses:
'200':
description: Успішне отримання головної сторінки.
security: []
/recipe:
get:
tags:
- Page
summary: Отримання сторінки інформації про рецепт
description: Обробляє HTTP GET-запит для отримання сторінки рецепта.
responses:
'200':
description: Успішне отримання сторінки з рецептом.
security: []
/login:
get:
tags:
- Page
summary: Отримання сторінки входу
description: Обробляє HTTP GET-запит для отримання сторінки входу в акаунт.
responses:
'200':
description: Успішне отримання сторінки входу.
security: []
/registration:
get:
tags:
- Page
summary: Отримання сторінки реєстрації
description: Обробляє HTTP GET-запит для отримання сторінки реєстрації акаунту.
responses:
'200':
description: Успішне отримання сторінки реєстрації.
security: []
/profile:
get:
tags:
- Page
summary: Отримання сторінки профілю користувача
description: Обробляє HTTP GET-запит для отримання сторінки профілю користувача.
responses:
'200':
description: Успішне отримання сторінки профілю користувача.
/create:
get:
tags:
- Page
summary: Отримання сторінки для створення рецепта
description: Обробляє HTTP GET-запит для отримання сторінки створення рецепта.
responses:
'200':
description: Успішне отримання сторінки створення рецепта.
/edit:
get:
tags:
- Page
summary: Отримання сторінки редагування рецепта
description: Обробляє HTTP GET-запит для отримання сторінки редагування рецепта.
responses:
'200':
description: Успішне отримання сторінки редагування рецепта.
/products:
get:
tags:
- Product
summary: Отримання списку всіх продуктів
description: Обробляє HTTP GET-запит для отримання списку всіх продуктів. Якщо властивість Weight має значення null - то кількість є вагою у грамах, а якщо властивість має дані - то вага у грамах буде у цій властивості.
responses:
'200':
description: Успішне отримання спуску всіх продуктів.
content:
application/json:
example:
- id: 1
name: Філе минтая
amount: 100
weight: null
unit: г
calories: 72
proteins: 16
carbohydrate: 0
fats: 1
- id: 2
name: Білий хліб
amount: 100
weight: null
unit: г
calories: 257
proteins: 7.7
carbohydrate: 52
fats: 1
- id: 3
name: Молоко 2.5%
amount: 100
weight: null
unit: мл
calories: 51
proteins: 3
carbohydrate: 4.7
fats: 2.5
- id: 4
name: Яйце куряче
amount: 1
weight: 55
unit: шт
calories: 83
proteins: 7
carbohydrate: 0.5
fats: 6
security: []
/recipes:
get:
tags:
- Recipe
summary: Отримання списку усіх рецептів
description: Обробляє HTTP GET-запит для отримання рецептів. Включаючи у себе коментарі до рецепта та його категорію.
responses:
'200':
description: Успішне оптимання списку рецептів.
content:
application/json:
example:
- id: 4
name: Рибні котлети
description: Рибні котлети – це ароматна, неймовірно смачна та дієтична страва. Вони на тривалий час насичують організм, ідеально поєднується з різноманітними гарнірами та соусами. Ніжні рибні котлети стануть чудовою альтернативою звичайній смаженій рибі.
photoName: rybni-kotlety.jpg
difficulty: Нормально
views: 32
cookingTime: '01:00:00'
ingredients: []
cookingSteps: []
comments:
- id: 1
userName: Олег
title: Все вийшло, рецепт дуже класний, раджу всім!
createTime: '2024-01-11T17:08:09.7597136'
countOfLikes: 0
rating: 5
recipeId: 4
- id: 2
userName: Катерина
title: Спочатку трішки не вийшло з чисткою риби, але потім все зробила так як треба, чоловіку дуже сподобалось:)
createTime: '2024-01-11T17:08:09.759719'
countOfLikes: 0
rating: 4
recipeId: 4
createDate: '2024-01-11T17:08:09.7597221'
user: null
userId: 1
category:
id: 11
name: Страви з риби
recipeCount: 0
subcategories: []
parentCategoryId: 2
categoryId: 11
- id: 5
name: Розсольник
description: |-
Розсольник по-домашньому – поживна перша страва, рецепт якої заснований на солоних огірках або огірковому розсолі. Цікаво, що раніше розсолом називали пиріг з куркою, гречаною кашею та порізаними вареними яйцями, а в начинку підливали розсіл. Цей рецепт розсольнику навіть згадував Гоголь у «Мертвих душах». Рецепт супу розсольник з’явився згодом – на огірковому розсолі, лимонному соку або капустяному розсолі.
Спочатку спробуємо, як приготувати розсольник з огірками за класичним рецептом з перловкою, а тоді вже будемо знати, як правильно варити розсольник з рисом і м’ясом або розсольник з грибами та перловкою. Цікаво буде спробувати інші варіанти: вегетаріанський розсольник – пісний рецепт, розсольник в мультиварці, розсольник з рибою, розсольник з фрикадельками. Смачний виходить розсольник за рецептом приготування з куркою та пшоном або гречкою.
photoName: d2763a20-870e-4e74-8a46-928cf83b58bbrozsolnyk-1024x683.jpg
difficulty: Легко
views: 46
cookingTime: '01:20:00'
ingredients: []
cookingSteps: []
comments:
- id: 3
userName: Валентина
title: Суп неймовірно смачнючий!!! Рекомендую всім)
createTime: '2024-01-11T17:19:16.0210087'
countOfLikes: 0
rating: 5
recipeId: 5
createDate: '2024-01-11T17:11:42.3669228'
user: null
userId: 1
category:
id: 7
name: Гарячі супи
recipeCount: 0
subcategories: []
parentCategoryId: 1
categoryId: 7
security: []
post:
tags:
- Recipe
summary: Надсилання моделі рецепта для його створення
description: Обробляє HTTP POST-запит для надсилання моделі рецепта для його створення.
requestBody:
description: Приклад моделі рецепту для створення.
required: true
content:
application/json:
example:
name: Тестовий рецепт
photoName: e8291ef7-befd-4e2b-b93c-cd95dc0f0e69rybni-kotlety.jpg
category: Морозиво
cookingTime: 45
difficulty: Складно
description: Опис рецепту створеного для тестування.
ingredients:
- id: 10
amount: '1000'
- id: 3
amount: '500'
- id: 55
amount: '200'
cookingSteps:
- stepIndex: 1
title: Перший крок приготування.
- stepIndex: 2
title: Другий крок приготування.
- stepIndex: 3
title: Третій крок приготування.
responses:
'200':
description: Успіше створення рецепта.
'400':
description: Некоректна модель рецепта у запиті для створення.
put:
tags:
- Recipe
summary: Надсилання моделі рецепта для оновлення його даних
description: Обробляє HTTP POST-запит для надсилання моделі рецепта для його отовлення у базі даних. Редагування рецепту.
requestBody:
description: Приклад моделі рецепта для оновлення. Обов'язкова наявність властивості "id" вже існуючого рецепта.
required: true
content:
application/json:
example:
id: 11
name: Скумбрія, запечена у фользі
photoName: 10cf65da-613f-4e67-abee-987ec18ee195skumbria-1024x683.jpg
category: Страви з риби
difficulty: Легко
cookingTime: 45
description: Приготувати скумбрію запечену найкраще в рукаві або у фользі. Саме запечена скумбрія, на відміну від інших способів приготування цієї риби, вирізняється приголомшливими смаковими характеристиками.
ingredients:
- id: 50
amount: 2
- id: 27
amount: 150
- id: 51
amount: 0.5
- id: 6
amount: 2
- id: 7
amount: 0
cookingSteps:
- id: 68
stepIndex: 1
title: У риби відрізаємо голову, розрізаємо черевце, виймаємо нутрощі та промиваємо. Просушуємо серветками.
recipeId: 11
- id: 69
stepIndex: 2
title: Лимон миємо, нарізаємо тонкими кружечками.
recipeId: 11
- id: 70
stepIndex: 3
title: Помідор миємо, нарізаємо кружальцями або пів кружальцями.
recipeId: 11
- id: 71
stepIndex: 4
title: На рибі зробимо кілька надрізів. Посолимо, поперчимо, у кожен надріз вкладемо по шматочку помідора та лимона.
recipeId: 11
- id: 72
stepIndex: 5
title: Викладаємо скумбрію на фольгу, рясно змащуємо олією. Загортаємо у фольгу.
recipeId: 11
- id: 73
stepIndex: 6
title: Викладаємо рибу на деко та запікаємо у заздалегідь розігрітій духовці протягом 25-30 хвилин за температури 190°С.
recipeId: 11
- id: 74
stepIndex: 7
title: Скумбрія, запечена у фользі, готова. Подавати можна гарячою та холодною, з улюбленим гарніром.
recipeId: 11
responses:
'200':
description: Успішне оновлення даних рецепта.
'400':
description: Невірна модель у запиті або відсутність рецепта за вказаним ідентифікатором.
/recipes/{id}:
get:
tags:
- Recipe
summary: Отримання рецепту за його ідентифікатором
description: "Обробляє HTTP GET-запит для отримання рецепта за ідентифікатором. У об'єкт рецепту включені всі його об'єкти: інгредієнти, категорія, кроки приготування, коментарі та власник рецепту."
parameters:
- name: id
in: path
required: true
description: Ідентифікатор рецепта.
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: Успішне отримання рецепту за ідентифікатором.
content:
application/json:
example:
id: 10
name: Макарони по-флотськи
description: Макарони по-флотськи – це проста й апетитна страва. Якщо немає часу на готування, макарони по-флотськи – це ваш варіант смачно та ситно нагодувати родину. Для приготування використовують різний фарш, усе залежить від ваших уподобань.
photoName: 31fb673d-f451-426a-b1af-73ca0ada9d2fmakarony-po-flotsky-1024x683.jpg
difficulty: Легко
views: 46
cookingTime: '00:35:00'
ingredients:
- id: 84
product:
id: 44
name: Макарони
amount: 1
weight: 100
unit: скл.
calories: 344
proteins: 10.4
carbohydrate: 71.5
fats: 1.1
productId: 44
amount: 4
recipeId: 10
- id: 85
product:
id: 49
name: Фарш курячий
amount: 100
weight: null
unit: г
calories: 143
proteins: 17.4
carbohydrate: 0
fats: 8
productId: 49
amount: 500
recipeId: 10
- id: 86
product:
id: 5
name: Цибуля ріпчаста
amount: 1
weight: 70
unit: шт
calories: 43
proteins: 1.5
carbohydrate: 9
fats: 0.25
productId: 5
amount: 2
recipeId: 10
- id: 87
product:
id: 13
name: Морква
amount: 1
weight: 85
unit: шт
calories: 35
proteins: 1
carbohydrate: 7.3
fats: 0.2
productId: 13
amount: 1
recipeId: 10
- id: 88
product:
id: 6
name: Олія соняшникова
amount: 1
weight: 12
unit: ст. л.
calories: 108
proteins: 0.01
carbohydrate: 0.01
fats: 12
productId: 6
amount: 5
recipeId: 10
- id: 89
product:
id: 7
name: Сіль, чорний перець
amount: 0
weight: null
unit: null
calories: 0
proteins: 0
carbohydrate: 0
fats: 0
productId: 7
amount: 0
recipeId: 10
cookingSteps:
- id: 60
stepIndex: 1
title: Перекладаємо фарш на розігріту з олією сковорідку. Солимо та перчимо. Готуємо за помірного нагрівання, час від часу перевертаючи.
recipeId: 10
- id: 61
stepIndex: 2
title: Цибулю очищаємо та нарізаємо кубиками.
recipeId: 10
- id: 62
stepIndex: 3
title: Коли фарш посвітліє, додаємо до нього подрібнену цибулю.
recipeId: 10
- id: 63
stepIndex: 4
title: Моркву натираємо теркою і перекладаємо у сковорідку. Періодично перевертаючи, готуємо до повної готовності.
recipeId: 10
- id: 64
stepIndex: 5
title: Відварюємо макарони. У воду попередньо наллємо 1-2 столові ложки олії.
recipeId: 10
- id: 65
stepIndex: 6
title: Готові макарони відкидаємо на друшляк та перекладаємо у велику миску. Додаємо до макаронів по-флотськи м'ясну засмажку та перемішуємо.
recipeId: 10
- id: 66
stepIndex: 7
title: Перекладаємо макарони по-флотськи у сковорідку та прогріваємо усе разом приблизно 5-7 хвилин.
recipeId: 10
- id: 67
stepIndex: 8
title: Подаємо з зеленню, кетчупом або гірчицею.
recipeId: 10
comments: []
createDate: '2024-01-12T09:25:05.924034'
user:
id: 1
name: Артем
surname: Бабенко
email: artem@gmail.com
password: '123123123'
age: 43
gender: male
userId: 1
category:
id: 15
name: Паста
recipeCount: 0
subcategories: []
parentCategoryId: 2
categoryId: 15
security: []
delete:
tags:
- Recipe
summary: Видалення рецепта за його ідентифікатором
description: Обробляє HTTP DELETE-запит для видалення рецепта за ідентифікатором. Також видалення його фото.
parameters:
- name: id
in: path
required: true
style: simple
description: Ідентифікатор рецепта, який треба видалити.
schema:
type: integer
format: int32
responses:
'200':
description: Ушпішне видалення рецепта.
'404':
description: Рецепт не знайдено.
/recipe/comments/{recipeId}:
post:
tags:
- Recipe
summary: Надсилання та створення коментаря для рецепта
description: Обробляє HTTP POST-запит для надсилання та створення коментаря.
parameters:
- name: recipeId
in: path
required: true
description: Ідентифікатор рецепта, якому буде доданий коментар.
style: simple
schema:
type: integer
format: int32
requestBody:
description: Об'єкт коментар.
required: true
content:
application/json:
example:
userName: Артем
title: Ця паста справила на мене дуже приємне враження.
rating: '5'
responses:
'200':
description: Успішне додавання коментаря.
'400':
description: Невірне тіло запиту або не знайдено рецепт якому додавати коментар.
security: []
/recipes/photo:
post:
tags:
- Recipe
summary: Завантаження фото для рецепта
description: Обробляє HTTP POST-запит для завантаження фото страви.
requestBody:
description: |
Об'єкт FormData з фотографією яку треба додати.
Приклад:
const data = new FormData();
data.append('FileName', document.getElementById('photo').value);
data.append('Image', document.getElementById('photo').files[0]);
const response = await fetch('/recipes/photo', {
method: "POST",
body: data
});
content:
formData:
example: |
------WebKitFormBoundaryguXfM809s1UnkEsH
Content-Disposition: form-data; name="FileName"
C:\fakepath\rybni-kotlety.jpg
------WebKitFormBoundaryguXfM809s1UnkEsH
Content-Disposition: form-data; name="Image"; filename="rybni-kotlety.jpg"
Content-Type: image/jpeg
------WebKitFormBoundaryguXfM809s1UnkEsH--
responses:
'200':
description: Успішне завантаження фото на сервер. Властивість fileName - ім'я файлу у папці ../photos/*
content:
application/json:
example:
fileName: f7ebdad6-4589-4e32-b81b-51443b9886b4rybni-kotlety.jpg
/user/login:
post:
tags:
- User
summary: Надсилання запиту на вхід в акаунт
description: Обробляє HTTP POST-запит надсилання даних користувача для входу. Створення аутентифікаційних кук для користувача.
requestBody:
description: Об'єкт даних для запиту на вхід.
required: true
content:
application/json:
example:
email: artem@gmail.com
password: '123123123'
responses:
'200':
description: Успішний вхід в акаунт та успішне створення аутентифікаційних кук.
'400':
description: Невірна модель даних для входу.
'401':
description: Користувач незареєстрований.
security: []
/user/logout:
get:
tags:
- User
summary: Вихід з акаунту
description: Обробляє HTTP GET-запит для видалення аутентифікаційних кук. Перехід на головну сторінку.
responses:
'200':
description: Усішний вихід з акаунту та видалення аутентифікаційних кук.
security: []
/user/registration:
post:
tags:
- User
summary: Надсилання реєстраційних даних нового користувача
description: Обробляє HTTP POST-запит для надсилання реєстраційних даних користувача. Додає користувача до бази даних та створює аутентифікаційні куки. Перехід на головну сторінку.
requestBody:
description: Об'єкт реєстраційних даних.
required: true
content:
application/json:
example:
name: Артем
surname: Бабенко
email: testemail@gmail.com
password: '987987987'
responses:
'200':
description: Успішне створення акаунту та вхід у нього.
'400':
description: Невірне тіло запиту.
security: []
/user:
get:
tags:
- User
summary: Отримання даних про користувача
description: Обробляє HTTP GET-запит для отримання поточного користувача з його усіма даними.
responses:
'200':
description: Успішне отримання даних про користувача. Сategories - це категорії у яких користувач створив рецепти. Recipes - це рецепти, які створив користувач.
content:
application/json:
example:
user:
id: 1
name: Артем
surname: Бабенко
email: artem@gmail.com
password: '123123123'
age: 43
gender: male
categories:
- category:
id: 11
name: Страви з риби
recipeCount: 0
subcategories: []
parentCategoryId: 2
recipeCount: 2
- category:
id: 7
name: Гарячі супи
recipeCount: 0
subcategories: []
parentCategoryId: 1
recipeCount: 2
- category:
id: 8
name: Холодні супи
recipeCount: 0
subcategories: []
parentCategoryId: 1
recipeCount: 1
- category:
id: 10
name: Страви з м'яса
recipeCount: 0
subcategories: []
parentCategoryId: 2
recipeCount: 3
- category:
id: 16
name: Запіканки
recipeCount: 0
subcategories: []
parentCategoryId: 2
recipeCount: 1
- category:
id: 15
name: Паста
recipeCount: 0
subcategories: []
parentCategoryId: 2
recipeCount: 1
totalComments: 10
recipes:
- id: 4
name: Рибні котлети
description: Рибні котлети – це ароматна, неймовірно смачна та дієтична страва. Вони на тривалий час насичують організм, ідеально поєднується з різноманітними гарнірами та соусами. Ніжні рибні котлети стануть чудовою альтернативою звичайній смаженій рибі.
photoName: rybni-kotlety.jpg
difficulty: Нормально
views: 33
cookingTime: '01:00:00'
ingredients: []
cookingSteps: []
comments:
- id: 1
userName: Олег
title: Все вийшло, рецепт дуже класний, раджу всім!
createTime: '2024-01-11T17:08:09.7597136'
countOfLikes: 0
rating: 5
recipeId: 4
- id: 2
userName: Катерина
title: Спочатку трішки не вийшло з чисткою риби, але потім все зробила так як треба, чоловіку дуже сподобалось:)
createTime: '2024-01-11T17:08:09.759719'
countOfLikes: 0
rating: 4
recipeId: 4
- id: 4
userName: Василь
title: Ну мені дуже сильно зайшли ці котлети, я б сказав "зі свисом" ;)))
createTime: '2024-01-11T18:51:01.5678819'
countOfLikes: 0
rating: 5
recipeId: 4
createDate: '2024-01-11T17:08:09.7597221'
user:
id: 1
name: Артем
surname: Бабенко
email: artem@gmail.com
password: '123123123'
age: 43
gender: male
userId: 1
category:
id: 11
name: Страви з риби
recipeCount: 0
subcategories: []
parentCategoryId: 2
categoryId: 11
- id: 5
name: Розсольник
description: |-
Розсольник по-домашньому – поживна перша страва, рецепт якої заснований на солоних огірках або огірковому розсолі. Цікаво, що раніше розсолом називали пиріг з куркою, гречаною кашею та порізаними вареними яйцями, а в начинку підливали розсіл. Цей рецепт розсольнику навіть згадував Гоголь у «Мертвих душах». Рецепт супу розсольник з’явився згодом – на огірковому розсолі, лимонному соку або капустяному розсолі.
Спочатку спробуємо, як приготувати розсольник з огірками за класичним рецептом з перловкою, а тоді вже будемо знати, як правильно варити розсольник з рисом і м’ясом або розсольник з грибами та перловкою. Цікаво буде спробувати інші варіанти: вегетаріанський розсольник – пісний рецепт, розсольник в мультиварці, розсольник з рибою, розсольник з фрикадельками. Смачний виходить розсольник за рецептом приготування з куркою та пшоном або гречкою.
photoName: d2763a20-870e-4e74-8a46-928cf83b58bbrozsolnyk-1024x683.jpg
difficulty: Легко
views: 46
cookingTime: '01:20:00'
ingredients: []
cookingSteps: []
comments:
- id: 3
userName: Валентина
title: Суп неймовірно смачнючий!!! Рекомендую всім)
createTime: '2024-01-11T17:19:16.0210087'
countOfLikes: 0
rating: 5
recipeId: 5
createDate: '2024-01-11T17:11:42.3669228'
user:
id: 1
name: Артем
surname: Бабенко
email: artem@gmail.com
password: '123123123'
age: 43
gender: male
userId: 1
category:
id: 7
name: Гарячі супи
recipeCount: 0
subcategories: []