From 1a32173fc73bbb94906f9ffde5874d47f6dfdad8 Mon Sep 17 00:00:00 2001 From: luoer Date: Wed, 2 Aug 2023 20:16:26 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E4=BC=98=E5=8C=96swagger=E7=9A=84?= =?UTF-8?q?=E7=94=9F=E6=88=90=E8=AE=BE=E7=BD=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/database/db.sqlite | Bin 147456 -> 147456 bytes src/common/response/pagination.dto.ts | 4 ++-- src/common/swagger/util.ts | 1 - src/modules/user/dto/find-user.dto.ts | 2 +- src/modules/user/entities/user.entity.ts | 1 + src/modules/user/user.controller.ts | 10 +++++----- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/content/database/db.sqlite b/content/database/db.sqlite index be985532f708e563730d217f2979c734fa5ec5be..949ef2e2242c2c1f308732200a8358289bdb9126 100644 GIT binary patch delta 432 zcmZo@;B08%oFL68I#I@%QM56kHGy$!0@E^ip*0MA#yl}xT^zgEUb5;lS2C{IEGRIA zk*nEDke|UA1gD==WKxkeQZO{KGBB|+GBq+VGS)S)&^15^ZT{ET%(%TunW>#ekjsvN zmD7TO&z`4;YZj*k=Wd{RYMg?N45EAx^B5#0qZuR_rYBl439BI+W?*FsM21*|rn6cx zS#mWph(V2*e#4SU8RR4bD`QJ56ErPgA+Qz!o@Ry^kS7?BEd|+ZDb$=M0`(w+x@2pt zyClQpgR^8nh8kKKSXddDA-e-AwE6k0d5ofb<_w%*uQY22LyQ0#KfT|ENl5^#+t9+w z&>$ouKR2;>^XWOcj8Z`BIY1hk?Sx?JMI~EZK~{Rsli`DeqoI|Ffn#1?;^yjkt&9Nv CU|kge delta 252 zcmZo@;B08%oFL7}KT*b+k-ssaHGy$!0@E^iq5TYe#yl}xT^zgEUb5;lS2FJ3EGV#? zk*nEUke|UA2pOhtQ)E(^{JMi{^S{Ps#_d(gOzk{^3=9mcoaY(%%z2u*)^gc#o(JmM z%gLE5#s}4O)RIY=%TU3<+{(bf%G7K+s}+-_K&~iMnn6-Bnn99bdZHDR@bnl Number(value)) - page: number; + page?: number; /** * 每页条数 @@ -24,5 +24,5 @@ export class PaginationDto { @IsNumber() @Min(1) @Transform(({ value }) => Number(value)) - size: number; + size?: number; } diff --git a/src/common/swagger/util.ts b/src/common/swagger/util.ts index 6199ccd..6643162 100644 --- a/src/common/swagger/util.ts +++ b/src/common/swagger/util.ts @@ -37,7 +37,6 @@ export function addResponseWrapper(doc: OpenAPIObject) { }, { type: 'object', - description: '返回数据', properties: { data: schema, }, diff --git a/src/modules/user/dto/find-user.dto.ts b/src/modules/user/dto/find-user.dto.ts index a353382..79e4df3 100644 --- a/src/modules/user/dto/find-user.dto.ts +++ b/src/modules/user/dto/find-user.dto.ts @@ -9,5 +9,5 @@ export class FindUserDto extends IntersectionType(PaginationDto) { */ @IsOptional() @IsString() - nickname: string; + nickname?: string; } diff --git a/src/modules/user/entities/user.entity.ts b/src/modules/user/entities/user.entity.ts index c4a3f74..1b41fe4 100644 --- a/src/modules/user/entities/user.entity.ts +++ b/src/modules/user/entities/user.entity.ts @@ -61,6 +61,7 @@ export class User extends BaseEntity { /** * 用户角色 */ + @ApiHideProperty() @ManyToMany(() => Role, (role) => role.user) @JoinTable() roles: Role[]; diff --git a/src/modules/user/user.controller.ts b/src/modules/user/user.controller.ts index 96a8a4b..25355fc 100644 --- a/src/modules/user/user.controller.ts +++ b/src/modules/user/user.controller.ts @@ -16,7 +16,7 @@ export class UserController extends BaseController { } @Post() - @ApiOperation({ summary: '创建用户', operationId: 'addUser' }) + @ApiOperation({ description: '创建用户', operationId: 'addUser' }) create(@Body() createUserDto: CreateUserDto) { return this.userService.create(createUserDto); } @@ -24,26 +24,26 @@ export class UserController extends BaseController { @Get() @Respond(Respond.PAGINATION) @ApiOkResponse({ isArray: true, type: User }) - @ApiOperation({ summary: '批量查询用户', operationId: 'getUsers' }) + @ApiOperation({ description: '批量查询用户', operationId: 'getUsers' }) async findMany(@Query() query: FindUserDto) { return this.userService.findMany(query); } @Get(':id') @Version('2') - @ApiOperation({ summary: '查询用户', operationId: 'getUserv2' }) + @ApiOperation({ description: '查询用户', operationId: 'getUserv2' }) findOne(@Param('id') id: number) { return this.userService.findOne(+id); } @Patch(':id') - @ApiOperation({ summary: '更新用户', operationId: 'updateUser' }) + @ApiOperation({ description: '更新用户', operationId: 'updateUser' }) update(@Param('id') id: number, @Body() updateUserDto: UpdateUserDto) { return this.userService.update(+id, updateUserDto); } @Delete(':id') - @ApiOperation({ summary: '删除用户', operationId: 'deleteUser' }) + @ApiOperation({ description: '删除用户', operationId: 'deleteUser' }) remove(@Param('id') id: number) { return this.userService.remove(+id); }