rogee/quyun-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: 更新路由参数格式，增强路由一致性和可读性

Browse Source
This commit is contained in:
Rogee
2025-12-24 11:02:05 +08:00
parent 469d691a75
commit 40776b78e2
5 changed files with 59 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
backend/app/http/super/order.go
View File

@@ -41,7 +41,7 @@ func (*order) list(ctx fiber.Ctx, filter *dto.OrderPageFilter) (*requests.Pager,
// @Param orderID path int64 true "OrderID"
// @Success 200 {object} dto.SuperOrderDetail
//
// @Router /super/v1/orders/:orderID [get]
// @Router /super/v1/orders/:orderID<int> [get]
// @Bind orderID path
func (*order) detail(ctx fiber.Ctx, orderID int64) (*dto.SuperOrderDetail, error) {
return services.Order.SuperOrderDetail(ctx, orderID)
@@ -58,7 +58,7 @@ func (*order) detail(ctx fiber.Ctx, orderID int64) (*dto.SuperOrderDetail, error
// @Param form body dto.SuperOrderRefundForm true "Form"
// @Success 200 {object} models.Order
//
// @Router /super/v1/orders/:orderID/refund [post]
// @Router /super/v1/orders/:orderID<int>/refund [post]
// @Bind orderID path
// @Bind form body
func (*order) refund(ctx fiber.Ctx, orderID int64, form *dto.SuperOrderRefundForm) (*models.Order, error) {

32
backend/app/http/super/routes.gen.go
View File

@@ -61,8 +61,8 @@ func (r *Routes) Register(router fiber.Router) {
r.order.list,
Query[dto.OrderPageFilter]("filter"),
))
r.log.Debugf("Registering route: Get /super/v1/orders/:orderID -> order.detail")
router.Get("/super/v1/orders/:orderID"[len(r.Path()):], DataFunc1(
r.log.Debugf("Registering route: Get /super/v1/orders/:orderID<int> -> order.detail")
router.Get("/super/v1/orders/:orderID<int>"[len(r.Path()):], DataFunc1(
r.order.detail,
PathParam[int64]("orderID"),
))
@@ -70,8 +70,8 @@ func (r *Routes) Register(router fiber.Router) {
router.Get("/super/v1/orders/statistics"[len(r.Path()):], DataFunc0(
r.order.statistics,
))
r.log.Debugf("Registering route: Post /super/v1/orders/:orderID/refund -> order.refund")
router.Post("/super/v1/orders/:orderID/refund"[len(r.Path()):], DataFunc2(
r.log.Debugf("Registering route: Post /super/v1/orders/:orderID<int>/refund -> order.refund")
router.Post("/super/v1/orders/:orderID<int>/refund"[len(r.Path()):], DataFunc2(
r.order.refund,
PathParam[int64]("orderID"),
Body[dto.SuperOrderRefundForm]("form"),
@@ -82,8 +82,8 @@ func (r *Routes) Register(router fiber.Router) {
r.tenant.list,
Query[dto.TenantFilter]("filter"),
))
r.log.Debugf("Registering route: Get /super/v1/tenants/:tenantID/users -> tenant.users")
router.Get("/super/v1/tenants/:tenantID/users"[len(r.Path()):], DataFunc2(
r.log.Debugf("Registering route: Get /super/v1/tenants/:tenantID<int>/users -> tenant.users")
router.Get("/super/v1/tenants/:tenantID<int>/users"[len(r.Path()):], DataFunc2(
r.tenant.users,
PathParam[int64]("tenantID"),
Query[tenantdto.AdminTenantUserListFilter]("filter"),
@@ -92,14 +92,14 @@ func (r *Routes) Register(router fiber.Router) {
router.Get("/super/v1/tenants/statuses"[len(r.Path()):], DataFunc0(
r.tenant.statusList,
))
r.log.Debugf("Registering route: Patch /super/v1/tenants/:tenantID -> tenant.updateExpire")
router.Patch("/super/v1/tenants/:tenantID"[len(r.Path()):], Func2(
r.log.Debugf("Registering route: Patch /super/v1/tenants/:tenantID<int> -> tenant.updateExpire")
router.Patch("/super/v1/tenants/:tenantID<int>"[len(r.Path()):], Func2(
r.tenant.updateExpire,
PathParam[int64]("tenantID"),
Body[dto.TenantExpireUpdateForm]("form"),
))
r.log.Debugf("Registering route: Patch /super/v1/tenants/:tenantID/status -> tenant.updateStatus")
router.Patch("/super/v1/tenants/:tenantID/status"[len(r.Path()):], Func2(
r.log.Debugf("Registering route: Patch /super/v1/tenants/:tenantID<int>/status -> tenant.updateStatus")
router.Patch("/super/v1/tenants/:tenantID<int>/status"[len(r.Path()):], Func2(
r.tenant.updateStatus,
PathParam[int64]("tenantID"),
Body[dto.TenantStatusUpdateForm]("form"),
@@ -115,8 +115,8 @@ func (r *Routes) Register(router fiber.Router) {
r.user.list,
Query[dto.UserPageFilter]("filter"),
))
r.log.Debugf("Registering route: Get /super/v1/users/:userID/tenants -> user.tenants")
router.Get("/super/v1/users/:userID/tenants"[len(r.Path()):], DataFunc2(
r.log.Debugf("Registering route: Get /super/v1/users/:userID<int>/tenants -> user.tenants")
router.Get("/super/v1/users/:userID<int>/tenants"[len(r.Path()):], DataFunc2(
r.user.tenants,
PathParam[int64]("userID"),
Query[dto.UserTenantPageFilter]("filter"),
@@ -129,14 +129,14 @@ func (r *Routes) Register(router fiber.Router) {
router.Get("/super/v1/users/statuses"[len(r.Path()):], DataFunc0(
r.user.statusList,
))
r.log.Debugf("Registering route: Patch /super/v1/users/:userID/roles -> user.updateRoles")
router.Patch("/super/v1/users/:userID/roles"[len(r.Path()):], Func2(
r.log.Debugf("Registering route: Patch /super/v1/users/:userID<int>/roles -> user.updateRoles")
router.Patch("/super/v1/users/:userID<int>/roles"[len(r.Path()):], Func2(
r.user.updateRoles,
PathParam[int64]("userID"),
Body[dto.UserRolesUpdateForm]("form"),
))
r.log.Debugf("Registering route: Patch /super/v1/users/:userID/status -> user.updateStatus")
router.Patch("/super/v1/users/:userID/status"[len(r.Path()):], Func2(
r.log.Debugf("Registering route: Patch /super/v1/users/:userID<int>/status -> user.updateStatus")
router.Patch("/super/v1/users/:userID<int>/status"[len(r.Path()):], Func2(
r.user.updateStatus,
PathParam[int64]("userID"),
Body[dto.UserStatusUpdateForm]("form"),

6
backend/app/http/super/tenant.go
View File

@@ -55,7 +55,7 @@ func (*tenant) create(ctx fiber.Ctx, form *dto.TenantCreateForm) (*models.Tenant
// @Param filter query tenantdto.AdminTenantUserListFilter true "Filter"
// @Success 200 {object} requests.Pager{items=dto.SuperTenantUserItem}
//
// @Router /super/v1/tenants/:tenantID/users [get]
// @Router /super/v1/tenants/:tenantID<int>/users [get]
// @Bind tenantID path
// @Bind filter query
func (*tenant) users(ctx fiber.Ctx, tenantID int64, filter *tenantdto.AdminTenantUserListFilter) (*requests.Pager, error) {
@@ -71,7 +71,7 @@ func (*tenant) users(ctx fiber.Ctx, tenantID int64, filter *tenantdto.AdminTenan
// @Param tenantID path int64 true "TenantID"
// @Param form body dto.TenantExpireUpdateForm true "Form"
//
// @Router /super/v1/tenants/:tenantID [patch]
// @Router /super/v1/tenants/:tenantID<int> [patch]
// @Bind tenantID path
// @Bind form body
func (*tenant) updateExpire(ctx fiber.Ctx, tenantID int64, form *dto.TenantExpireUpdateForm) error {
@@ -92,7 +92,7 @@ func (*tenant) updateExpire(ctx fiber.Ctx, tenantID int64, form *dto.TenantExpir
// @Param tenantID path int64 true "TenantID"
// @Param form body dto.TenantStatusUpdateForm true "Form"
//
// @Router /super/v1/tenants/:tenantID/status [patch]
// @Router /super/v1/tenants/:tenantID<int>/status [patch]
// @Bind tenantID path
// @Bind form body
func (*tenant) updateStatus(ctx fiber.Ctx, tenantID int64, form *dto.TenantStatusUpdateForm) error {

6
backend/app/http/super/user.go
View File

@@ -38,7 +38,7 @@ func (*user) list(ctx fiber.Ctx, filter *dto.UserPageFilter) (*requests.Pager, e
// @Param filter query dto.UserTenantPageFilter true "Filter"
// @Success 200 {object} requests.Pager{items=dto.UserTenantItem}
//
// @Router /super/v1/users/:userID/tenants [get]
// @Router /super/v1/users/:userID<int>/tenants [get]
// @Bind userID path
// @Bind filter query
func (*user) tenants(ctx fiber.Ctx, userID int64, filter *dto.UserTenantPageFilter) (*requests.Pager, error) {
@@ -54,7 +54,7 @@ func (*user) tenants(ctx fiber.Ctx, userID int64, filter *dto.UserTenantPageFilt
// @Param userID path int64 true "UserID"
// @Param form body dto.UserStatusUpdateForm true "Form"
//
// @Router /super/v1/users/:userID/status [patch]
// @Router /super/v1/users/:userID<int>/status [patch]
// @Bind userID path
// @Bind form body
func (*user) updateStatus(ctx fiber.Ctx, userID int64, form *dto.UserStatusUpdateForm) error {
@@ -70,7 +70,7 @@ func (*user) updateStatus(ctx fiber.Ctx, userID int64, form *dto.UserStatusUpdat
// @Param userID path int64 true "UserID"
// @Param form body dto.UserRolesUpdateForm true "Form"
//
// @Router /super/v1/users/:userID/roles [patch]
// @Router /super/v1/users/:userID<int>/roles [patch]
// @Bind userID path
// @Bind form body
func (*user) updateRoles(ctx fiber.Ctx, userID int64, form *dto.UserRolesUpdateForm) error {