Skip to content

Commit 532716f

Browse files
authored
add: make path param work (#209)
1 parent 449bfcb commit 532716f

3 files changed

Lines changed: 55 additions & 54 deletions

File tree

apps/server/docs/openapi-generator.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ async function main() {
208208
}
209209
let fullPath = normalizePath(`/${basePath}/${routePath}`)
210210
fullPath = fullPath === '' ? '/' : fullPath
211+
fullPath = fullPath.replace(/:([a-zA-Z0-9_]+)/g, '{$1}')
211212

212213
// Security: @Public()?
213214
const isPublic = hasPublicDecorator(method.getDecorators())

apps/server/docs/swagger.json

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@
225225
]
226226
}
227227
},
228-
"/api/courses/:id": {
228+
"/api/courses/{id}": {
229229
"get": {
230230
"summary": "CourseController.getCourseById",
231231
"responses": {
@@ -253,7 +253,7 @@
253253
]
254254
}
255255
},
256-
"/api/courses/:id/lectures": {
256+
"/api/courses/{id}/lectures": {
257257
"get": {
258258
"summary": "CourseController.getLecturesByCourseId",
259259
"responses": {
@@ -292,7 +292,7 @@
292292
]
293293
}
294294
},
295-
"/api/courses/:id/reviews": {
295+
"/api/courses/{id}/reviews": {
296296
"get": {
297297
"summary": "CourseController.getReviewByCourseId",
298298
"responses": {
@@ -331,7 +331,7 @@
331331
]
332332
}
333333
},
334-
"/api/courses/:id/read": {
334+
"/api/courses/{id}/read": {
335335
"post": {
336336
"summary": "CourseController.readCourse",
337337
"responses": {
@@ -358,7 +358,7 @@
358358
]
359359
}
360360
},
361-
"/api/users/:userId/feeds": {
361+
"/api/users/{userId}/feeds": {
362362
"get": {
363363
"summary": "FeedsController.getUserFeeds",
364364
"responses": {
@@ -454,7 +454,7 @@
454454
]
455455
}
456456
},
457-
"/api/lectures/:id": {
457+
"/api/lectures/{id}": {
458458
"get": {
459459
"summary": "LecturesController.getLectureById",
460460
"responses": {
@@ -482,7 +482,7 @@
482482
]
483483
}
484484
},
485-
"/api/lectures/:lectureId/reviews": {
485+
"/api/lectures/{lectureId}/reviews": {
486486
"get": {
487487
"summary": "LecturesController.getLectureReviews",
488488
"responses": {
@@ -521,7 +521,7 @@
521521
]
522522
}
523523
},
524-
"/api/lectures/:lectureId/related-reviews": {
524+
"/api/lectures/{lectureId}/related-reviews": {
525525
"get": {
526526
"summary": "LecturesController.getLectureRelatedReviews",
527527
"responses": {
@@ -581,7 +581,7 @@
581581
"security": []
582582
}
583583
},
584-
"/api/users/:id/planners": {
584+
"/api/users/{id}/planners": {
585585
"get": {
586586
"summary": "PlannersController.getPlanners",
587587
"responses": {
@@ -654,7 +654,7 @@
654654
}
655655
}
656656
},
657-
"/api/users/:id/planners/:plannerId": {
657+
"/api/users/{id}/planners/{plannerId}": {
658658
"patch": {
659659
"summary": "PlannersController.updatePlanner",
660660
"responses": {
@@ -722,7 +722,7 @@
722722
]
723723
}
724724
},
725-
"/api/users/:id/planners/:plannerId/add-arbitrary-item": {
725+
"/api/users/{id}/planners/{plannerId}/add-arbitrary-item": {
726726
"post": {
727727
"summary": "PlannersController.addArbitraryItem",
728728
"responses": {
@@ -767,7 +767,7 @@
767767
}
768768
}
769769
},
770-
"/api/users/:id/planners/:plannerId/remove-item": {
770+
"/api/users/{id}/planners/{plannerId}/remove-item": {
771771
"post": {
772772
"summary": "PlannersController.removePlanner",
773773
"responses": {
@@ -804,7 +804,7 @@
804804
}
805805
}
806806
},
807-
"/api/users/:id/planners/:plannerId/add-future-item": {
807+
"/api/users/{id}/planners/{plannerId}/add-future-item": {
808808
"post": {
809809
"summary": "PlannersController.addFutureItem",
810810
"responses": {
@@ -849,7 +849,7 @@
849849
}
850850
}
851851
},
852-
"/api/users/:id/planners/:plannerId/reorder": {
852+
"/api/users/{id}/planners/{plannerId}/reorder": {
853853
"post": {
854854
"summary": "PlannersController.reorderPlanner",
855855
"responses": {
@@ -886,7 +886,7 @@
886886
}
887887
}
888888
},
889-
"/api/users/:id/planners/:plannerId/update-item": {
889+
"/api/users/{id}/planners/{plannerId}/update-item": {
890890
"post": {
891891
"summary": "PlannersController.updatePlannerItem",
892892
"responses": {
@@ -1031,7 +1031,7 @@
10311031
}
10321032
}
10331033
},
1034-
"/api/reviews/:reviewId": {
1034+
"/api/reviews/{reviewId}": {
10351035
"get": {
10361036
"summary": "ReviewsController.getReviewInstance",
10371037
"responses": {
@@ -1094,7 +1094,7 @@
10941094
}
10951095
}
10961096
},
1097-
"/api/reviews/:reviewId/like": {
1097+
"/api/reviews/{reviewId}/like": {
10981098
"post": {
10991099
"summary": "ReviewsController.likeReviewInstance",
11001100
"responses": {
@@ -1424,7 +1424,7 @@
14241424
}
14251425
}
14261426
},
1427-
"/api/users/:userId/timetables": {
1427+
"/api/users/{userId}/timetables": {
14281428
"get": {
14291429
"summary": "TimetablesController.getTimetables",
14301430
"responses": {
@@ -1487,7 +1487,7 @@
14871487
}
14881488
}
14891489
},
1490-
"/api/users/:userId/timetables/:timetableId": {
1490+
"/api/users/{userId}/timetables/{timetableId}": {
14911491
"get": {
14921492
"summary": "TimetablesController.getTimeTable",
14931493
"responses": {
@@ -1558,7 +1558,7 @@
15581558
]
15591559
}
15601560
},
1561-
"/api/users/:userId/timetables/:timetableId/add-lecture": {
1561+
"/api/users/{userId}/timetables/{timetableId}/add-lecture": {
15621562
"post": {
15631563
"summary": "TimetablesController.addLectureToTimetable",
15641564
"responses": {
@@ -1595,7 +1595,7 @@
15951595
}
15961596
}
15971597
},
1598-
"/api/users/:userId/timetables/:timetableId/remove-lecture": {
1598+
"/api/users/{userId}/timetables/{timetableId}/remove-lecture": {
15991599
"post": {
16001600
"summary": "TimetablesController.removeLectureFromTimetable",
16011601
"responses": {
@@ -1632,7 +1632,7 @@
16321632
}
16331633
}
16341634
},
1635-
"/api/users/:userId/timetables/:timetableId/reorder": {
1635+
"/api/users/{userId}/timetables/{timetableId}/reorder": {
16361636
"post": {
16371637
"summary": "TimetablesController.reorderTimetable",
16381638
"responses": {
@@ -1716,7 +1716,7 @@
17161716
"security": []
17171717
}
17181718
},
1719-
"/api/users/:user_id/taken-courses": {
1719+
"/api/users/{user_id}/taken-courses": {
17201720
"get": {
17211721
"summary": "UserController.getUserTakenCourses",
17221722
"responses": {
@@ -1754,7 +1754,7 @@
17541754
]
17551755
}
17561756
},
1757-
"/api/users/:user_id/liked-reviews": {
1757+
"/api/users/{user_id}/liked-reviews": {
17581758
"get": {
17591759
"summary": "UserController.getUserLikedReviews",
17601760
"responses": {
@@ -1792,7 +1792,7 @@
17921792
]
17931793
}
17941794
},
1795-
"/api/users/:userId/wishlist": {
1795+
"/api/users/{userId}/wishlist": {
17961796
"get": {
17971797
"summary": "WishlistController.getWishlist",
17981798
"responses": {
@@ -1819,7 +1819,7 @@
18191819
]
18201820
}
18211821
},
1822-
"/api/users/:userId/wishlist/add-lecture": {
1822+
"/api/users/{userId}/wishlist/add-lecture": {
18231823
"post": {
18241824
"summary": "WishlistController.addLecture",
18251825
"responses": {
@@ -1856,7 +1856,7 @@
18561856
}
18571857
}
18581858
},
1859-
"/api/users/:userId/wishlist/remove-lecture": {
1859+
"/api/users/{userId}/wishlist/remove-lecture": {
18601860
"post": {
18611861
"summary": "WishlistController.removeLecture",
18621862
"responses": {

0 commit comments

Comments
 (0)