feat: 拆分vo层

Author: kuangshp

src/dto/query.list.res.dto.ts

@@ -0,0 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class QueryListVo {
+  @ApiProperty({ description: '总页数' })
+  total: number;
+
+  @ApiProperty({ description: '页码' })
+  pageSize: number;
+
+  @ApiProperty({ description: '当前页' })
+  pageNumber: number;
+}

src/dto/query.list.vo.ts

@@ -1,6 +1,6 @@
 import { ApiProperty } from '@nestjs/swagger';
 
-export class QueryResDto {
+export class QueryVo {
   @ApiProperty({ description: '主键id' })
   id?: number;
 

src/dto/query.res.dto.ts src/dto/query.vo.ts

@@ -12,12 +12,12 @@ import {
   Get,
   Query,
 } from '@nestjs/common';
-import { ApiTags, ApiBearerAuth, ApiOperation, ApiCreatedResponse } from '@nestjs/swagger';
+import { ApiTags, ApiBearerAuth, ApiOperation, ApiOkResponse } from '@nestjs/swagger';
 import { AuthGuard } from '@src/guard/auth/auth.guard';
 import { AccessService } from '../../services/access/access.service';
 import { CreateAccessDto } from './dto/create.access.dto';
 import { UpdateAccessDto } from './dto/update.access.dto';
-import { AccessResDto, AccessListResDtoDto } from './dto/access.res.dto';
+import { AccessListVo, AccessVo } from './vo/access.vo';
 import { AccessReqDto } from './dto/access.req.dto';
 import { ApiAuth } from '@src/decorators/api.auth';
 
@@ -30,7 +30,7 @@ export class AccessController {
   constructor(private readonly accessService: AccessService) {}
 
   @ApiOperation({ summary: '创建资源', description: '创建资源' })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: String,
     description: '创建资源返回值',
   })
@@ -48,7 +48,7 @@ export class AccessController {
   }
 
   @ApiOperation({ summary: '修改资源', description: '根据资源ID修改资源' })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: String,
     description: '修改资源的返回值',
   })
@@ -64,14 +64,14 @@ export class AccessController {
     summary: '获取菜单',
     description: '获取全部的菜单(不分页,给角色分配资源使用)',
   })
-  @ApiCreatedResponse({
-    type: AccessResDto,
+  @ApiOkResponse({
+    type: AccessVo,
     isArray: true,
     description: '获取全部菜单返回DTO',
   })
   @HttpCode(HttpStatus.OK)
   @Get('access_list')
-  async accessList(): Promise<AccessResDto[]> {
+  async accessList(): Promise<AccessVo[]> {
     return await this.accessService.accessList();
   }
 
@@ -82,13 +82,12 @@ export class AccessController {
       url: 'xxx?pageSize=10&pageNumber=1',
     },
   })
-  @ApiCreatedResponse({
-    type: AccessResDto,
-    isArray: true,
+  @ApiOkResponse({
+    type: AccessListVo,
     description: '分页获取资源列表',
   })
   @Get()
-  async accessListPage(@Query() accessReqDto: AccessReqDto): Promise<AccessListResDtoDto> {
+  async accessListPage(@Query() accessReqDto: AccessReqDto): Promise<AccessListVo> {
     return await this.accessService.accessListPage(accessReqDto);
   }
 }

src/modules/admin/system/access/controllers/access/access.controller.ts

@@ -1,8 +1,8 @@
-import { QueryResDto } from '@src/dto/query.res.dto';
-import { QueryListVo } from '@src/dto/query.list.res.dto';
+import { QueryVo } from '@src/dto/query.vo';
+import { QueryListVo } from '@src/dto/query.list.vo';
 import { ApiProperty } from '@nestjs/swagger';
 
-export class AccessResDto extends QueryResDto {
+export class AccessVo extends QueryVo {
   @ApiProperty({ description: '模块名称' })
   moduleName: string;
 
@@ -28,8 +28,7 @@ export class AccessResDto extends QueryResDto {
   description?: string;
 }
 
-export class AccessListResDtoDto extends QueryListVo<AccessResDto> {
-  constructor(pageSize: number, pageNumber: number, data: AccessResDto[]) {
-    super(pageSize, pageNumber, data);
-  }
+export class AccessListVo extends QueryListVo {
+  @ApiProperty({ description: '返回数据列表', type: AccessVo, isArray: true })
+  data: AccessVo[];
 }

src/modules/admin/system/access/controllers/access/dto/access.res.dto.ts src/modules/admin/system/access/controllers/access/vo/access.vo.ts

@@ -1,8 +1,8 @@
 import { Controller, UseGuards, HttpCode, HttpStatus, Get } from '@nestjs/common';
-import { ApiTags, ApiBearerAuth, ApiOperation, ApiCreatedResponse } from '@nestjs/swagger';
+import { ApiTags, ApiBearerAuth, ApiOperation, ApiOkResponse } from '@nestjs/swagger';
 import { AuthGuard } from '@src/guard/auth/auth.guard';
 import { MenusService } from '../../services/menus/menus.service';
-import { MenusListResDto } from './dto/menus.res.dto';
+import { MenusListVo } from './vo/menus.vo';
 import { CurrentUser, ICurrentUserType } from '@src/decorators/current.user';
 
 @ApiTags('后台管理系统-菜单管理')
@@ -16,14 +16,14 @@ export class MenusController {
     summary: '获取菜单列表',
     description: '获取菜单',
   })
-  @ApiCreatedResponse({
-    type: MenusListResDto,
+  @ApiOkResponse({
+    type: MenusListVo,
     isArray: true,
     description: '获取菜单返回值',
   })
   @HttpCode(HttpStatus.OK)
   @Get()
-  async menusList(@CurrentUser() userInfo: ICurrentUserType): Promise<MenusListResDto[]> {
+  async menusList(@CurrentUser() userInfo: ICurrentUserType): Promise<MenusListVo[]> {
     return await this.menusService.menusList(userInfo);
   }
 }

src/modules/admin/system/access/controllers/menus/menus.controller.ts

@@ -1,7 +1,7 @@
-import { QueryResDto } from '@src/dto/query.res.dto';
+import { QueryVo } from '@src/dto/query.vo';
 import { ApiProperty } from '@nestjs/swagger';
 
-export class MenusListResDto extends QueryResDto {
+export class MenusListVo extends QueryVo {
   @ApiProperty({ description: '名称' })
   name: string;
 

src/modules/admin/system/access/controllers/menus/dto/menus.res.dto.ts src/modules/admin/system/access/controllers/menus/vo/menus.vo.ts

@@ -5,7 +5,7 @@ import { InjectRepository } from '@nestjs/typeorm';
 import { AccessEntity } from '../../entities/access.entity';
 import { Repository, getConnection } from 'typeorm';
 import { UpdateAccessDto } from '../../controllers/access/dto/update.access.dto';
-import { AccessResDto, AccessListResDtoDto } from '../../controllers/access/dto/access.res.dto';
+import { AccessListVo, AccessVo } from '../../controllers/access/vo/access.vo';
 import { RoleAccessEntity } from '../../../role/entities/role.access.entity';
 import { AccessReqDto } from '../../controllers/access/dto/access.req.dto';
 
@@ -121,7 +121,7 @@ export class AccessService {
    * @param {*}
    * @return {*}
    */
-  async accessList(): Promise<AccessResDto[]> {
+  async accessList(): Promise<AccessVo[]> {
     return await this.accessRepository.find({
       where: [{ type: 1 }, { type: 2 }],
       select: ['id', 'moduleName', 'actionName', 'sort'],
@@ -136,7 +136,7 @@ export class AccessService {
    * @param {number} type
    * @return {*}
    */
-  async accessListPage(accessReqDto: AccessReqDto): Promise<AccessListResDtoDto> {
+  async accessListPage(accessReqDto: AccessReqDto): Promise<AccessListVo> {
     const {
       pageSize = PageEnum.PAGE_SIZE,
       pageNumber = PageEnum.PAGE_NUMBER,

src/modules/admin/system/access/services/access/access.service.ts

@@ -2,7 +2,7 @@ import { Injectable, Logger } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 import { AccessEntity } from '../../entities/access.entity';
 import { Repository, getConnection } from 'typeorm';
-import { MenusListResDto } from '../../controllers/menus/dto/menus.res.dto';
+import { MenusListVo } from '../../controllers/menus/vo/menus.vo';
 import { ICurrentUserType } from '@src/decorators/current.user';
 import { AdminIdentityEnum, AccessTypeEnum } from '@src/enums';
 import { AccountRoleEntity } from '../../../account/entities/account.role.entity';
@@ -34,7 +34,7 @@ export class MenusService {
    * @param {ICurrentUserType} userInfo
    * @return {*}
    */
-  async menusList(userInfo: ICurrentUserType): Promise<MenusListResDto[]> {
+  async menusList(userInfo: ICurrentUserType): Promise<MenusListVo[]> {
     /**
      * 根据用户权限来返回菜单
      * 1.查询全部的菜单
@@ -101,7 +101,7 @@ export class MenusService {
    * @param {AccessEntity} accessList
    * @return {*}
    */
-  private formatMenus(accessList: IAccessList[]): MenusListResDto[] {
+  private formatMenus(accessList: IAccessList[]): MenusListVo[] {
     return accessList.map((item: IAccessList) => {
       const { id, moduleName, actionName, parentId, url, sort, icon } = item;
       return {

src/modules/admin/system/access/services/menus/menus.service.ts

@@ -9,10 +9,10 @@ import {
   Post,
   Body,
 } from '@nestjs/common';
-import { ApiTags, ApiBearerAuth, ApiOperation, ApiCreatedResponse } from '@nestjs/swagger';
+import { ApiTags, ApiBearerAuth, ApiOperation, ApiOkResponse } from '@nestjs/swagger';
 import { AuthGuard } from '@src/guard/auth/auth.guard';
 import { AccountRoleService } from '../../services/account-role/account-role.service';
-import { AccountRoleListResDto, RoleAccountListDto } from './dto/account.role.res.dto';
+import { AccountRoleListVo, RoleAccountListVo } from './vo/account.role.vo';
 import { DistributionRoleDto } from './dto/distribution.role.dto';
 import { ApiAuth } from '@src/decorators/api.auth';
 
@@ -25,21 +25,21 @@ export class AccountRoleController {
   constructor(private readonly accountRoleService: AccountRoleService) {}
 
   @ApiOperation({ summary: '获取角色列表', description: '根据当前的账号id获取角色已经授权的角色' })
-  @ApiCreatedResponse({
-    type: AccountRoleListResDto,
+  @ApiOkResponse({
+    type: AccountRoleListVo,
     isArray: true,
     description: '根据账号ID查询授权角色返回值',
   })
   @HttpCode(HttpStatus.OK)
   @Get(':accountId')
   async accountRoleListByAccountId(
     @Param('accountId', new ParseIntPipe()) accountId: number,
-  ): Promise<AccountRoleListResDto[] | undefined> {
+  ): Promise<AccountRoleListVo[] | undefined> {
     return this.accountRoleService.accountRoleListByAccountId(accountId);
   }
 
   @ApiOperation({ summary: '给账号分配角色', description: '给当前账号分配角色' })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: String,
     description: '给账号授权角色返回值',
   })
@@ -50,13 +50,13 @@ export class AccountRoleController {
   }
 
   @ApiOperation({ summary: '根据全部的角色', description: '给账号分配角色的时候使用' })
-  @ApiCreatedResponse({
-    type: RoleAccountListDto,
+  @ApiOkResponse({
+    type: RoleAccountListVo,
     isArray: true,
     description: '角色返回列表',
   })
   @Get()
-  async roleList(): Promise<RoleAccountListDto[]> {
+  async roleList(): Promise<RoleAccountListVo[]> {
     return await this.accountRoleService.roleList();
   }
 }

src/modules/admin/system/account/controllers/account-role/account-role.controller.ts

@@ -1,14 +1,14 @@
 import { ApiProperty } from '@nestjs/swagger';
 
-export class AccountRoleListResDto {
+export class AccountRoleListVo {
   @ApiProperty({ required: true, description: '账号ID' })
   accountId?: number;
 
   @ApiProperty({ required: true, description: '角色ID' })
   roleId?: number;
 }
 
-export class RoleAccountListDto {
+export class RoleAccountListVo {
   @ApiProperty({ required: true, description: '角色ID' })
   id: number;
 

src/modules/admin/system/account/controllers/account-role/dto/account.role.res.dto.ts src/modules/admin/system/account/controllers/account-role/vo/account.role.vo.ts

@@ -12,7 +12,7 @@ import {
   HttpStatus,
   HttpCode,
 } from '@nestjs/common';
-import { ApiOperation, ApiCreatedResponse, ApiTags, ApiBearerAuth } from '@nestjs/swagger';
+import { ApiOperation, ApiTags, ApiBearerAuth, ApiOkResponse } from '@nestjs/swagger';
 import { CreateAccountDto } from './dto/create.account.dto';
 import { AccountService } from '../../services/account/account.service';
 import { UpdateAccountDto } from './dto/update.account.dto';
@@ -35,7 +35,7 @@ export class AccountController {
     summary: '创建账号',
     description: '创建账号',
   })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: String,
     description: '创建账号返回值',
   })
@@ -46,7 +46,7 @@ export class AccountController {
   }
 
   @ApiOperation({ summary: '重置为默认密码', description: '根据id重置默认密码' })
-  @ApiCreatedResponse({ type: String, description: '重置密码返回值' })
+  @ApiOkResponse({ type: String, description: '重置密码返回值' })
   @HttpCode(HttpStatus.OK)
   @Post('reset_password')
   async resetPassword(@Body() data: { id: number }): Promise<string> {
@@ -55,7 +55,7 @@ export class AccountController {
   }
 
   @ApiOperation({ summary: '修改密码', description: '根据账号自己的密码' })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: String,
     description: '修改账号密码返回值',
   })
@@ -70,7 +70,7 @@ export class AccountController {
   }
 
   @ApiOperation({ summary: '删除账号', description: '根据id删除账号' })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: String,
     description: '修改账号返回值',
   })
@@ -81,7 +81,7 @@ export class AccountController {
   }
 
   @ApiOperation({ summary: '修改账号信息', description: '根据账号id修改账号信息' })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: String,
     description: '修改账号返回值',
   })
@@ -95,7 +95,7 @@ export class AccountController {
   }
 
   @ApiOperation({ summary: '查询账号信息', description: '根据账号id查询账号信息' })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: AccountVo,
     description: '查询单条账号返回值',
   })
@@ -112,9 +112,8 @@ export class AccountController {
       url: 'xx?pageSize=10&pageNumber=1&username=xx&email=xx&mobile=xx&status=0&platform=1',
     },
   })
-  @ApiCreatedResponse({
+  @ApiOkResponse({
     type: AccountListVo,
-    isArray: true,
     description: '分页查询账号返回值',
   })
   @HttpCode(HttpStatus.OK)

src/modules/admin/system/account/controllers/account/account.controller.ts

@@ -1,8 +1,8 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { QueryResDto } from '@src/dto/query.res.dto';
-import { QueryListVo } from '@src/dto/query.list.res.dto';
+import { QueryListVo } from '@src/dto/query.list.vo';
+import { QueryVo } from '@src/dto/query.vo';
 
-export class AccountVo extends QueryResDto {
+export class AccountVo extends QueryVo {
   @ApiProperty({ description: '用户名' })
   username?: string;
 
@@ -18,9 +18,7 @@ export class AccountVo extends QueryResDto {
   @ApiProperty({ description: '平台:0表示普通用户(没权限),1表示为运营管理,2表示入住商家' })
   platform?: number;
 }
-
-export class AccountListVo extends QueryListVo<AccountVo> {
-  constructor(pageSize: number, pageNumber: number, data: AccountVo[]) {
-    super(pageSize, pageNumber, data);
-  }
+export class AccountListVo extends QueryListVo {
+  @ApiProperty({ description: '返回数据列表', type: AccountVo, isArray: true })
+  data: AccountVo[];
 }