feat: Enhance Swagger documentation with new admin and user endpoints
Some checks failed
build quyun / Build (push) Failing after 2m1s

- Added definitions for admin authentication, media, posts, orders, and user management.
- Implemented new API paths for admin functionalities including authentication, media management, order processing, and user statistics.
- Updated existing endpoints to improve clarity and structure in the Swagger documentation.
- Introduced new response schemas for various operations to standardize API responses.
This commit is contained in:
2025-12-19 23:43:46 +08:00
parent 49072ddd79
commit 7b18a6a0e6
14 changed files with 4180 additions and 120 deletions

View File

@@ -19,9 +19,15 @@ type users struct{}
// List users
//
// @Router /admin/users [get]
// @Bind pagination query
// @Bind query query
// @Summary 用户列表
// @Tags Admin Users
// @Produce json
// @Param pagination query requests.Pagination false "分页参数"
// @Param query query UserListQuery false "筛选条件"
// @Success 200 {object} requests.Pager{items=models.User} "成功"
// @Router /admin/users [get]
// @Bind pagination query
// @Bind query query
func (ctl *users) List(ctx fiber.Ctx, pagination *requests.Pagination, query *UserListQuery) (*requests.Pager, error) {
conds := []gen.Condition{
models.UserQuery.Username.Like(database.WrapLike(*query.Keyword)),
@@ -31,17 +37,28 @@ func (ctl *users) List(ctx fiber.Ctx, pagination *requests.Pagination, query *Us
// Show user
//
// @Router /admin/users/:id [get]
// @Bind id path
// @Summary 用户详情
// @Tags Admin Users
// @Produce json
// @Param id path int64 true "用户 ID"
// @Success 200 {object} models.User "成功"
// @Router /admin/users/:id [get]
// @Bind id path
func (ctl *users) Show(ctx fiber.Ctx, id int64) (*models.User, error) {
return services.Users.FindByID(ctx, id)
}
// Articles show user bought articles
//
// @Router /admin/users/:id/articles [get]
// @Bind id path
// @Bind pagination query
// @Summary 用户已购作品
// @Tags Admin Users
// @Produce json
// @Param id path int64 true "用户 ID"
// @Param pagination query requests.Pagination false "分页参数"
// @Success 200 {object} requests.Pager{items=models.Post} "成功"
// @Router /admin/users/:id/articles [get]
// @Bind id path
// @Bind pagination query
func (ctl *users) Articles(ctx fiber.Ctx, id int64, pagination *requests.Pagination) (*requests.Pager, error) {
return services.Posts.Bought(ctx, id, pagination)
}
@@ -52,9 +69,16 @@ type UserBalance struct {
// Balance
//
// @Router /admin/users/:id/balance [post]
// @Bind id path
// @Bind balance body
// @Summary 调整用户余额
// @Tags Admin Users
// @Accept json
// @Produce json
// @Param id path int64 true "用户 ID"
// @Param balance body UserBalance true "请求体"
// @Success 200 {object} any "成功"
// @Router /admin/users/:id/balance [post]
// @Bind id path
// @Bind balance body
func (ctl *users) Balance(ctx fiber.Ctx, id int64, balance *UserBalance) error {
user, err := services.Users.FindByID(ctx, id)
if err != nil {