1、什么是controller
负责处理输入的 request 请求并向客户端进行相应的。
2、CRUD接口
import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/common';
import { UsersService } from './users.service';
import { CreateUserDto } from './dto/create-user.dto';
import { UpdateUserDto } from './dto/update-user.dto';
import { ApiTags,ApiOperation,ApiBearerAuth} from '@nestjs/swagger'
@Controller('users')
@ApiTags('用户管理')
export class UsersController {
constructor(private readonly usersService: UsersService) {}
@Post()
@ApiOperation({
summary: '新增用户',
})
@ApiBearerAuth()
create(@Body() createUserDto: CreateUserDto) {
return this.usersService.create(createUserDto);
}
@Get()
findAll() {
return this.usersService.findAll();
}
@Get(':id')
findOne(@Param('id') id: string) {
return this.usersService.findOne(+id);
}
@Patch(':id')
update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) {
return this.usersService.update(+id, updateUserDto);
}
@Delete(':id')
remove(@Param('id') id: string) {
return this.usersService.remove(+id);
}
}
@Get(':id')装饰器,负责接收get请求的位置参数id,然后可以进行使用@get(': id')装饰器,负责接收请求的位置参数id,然后可以进行使用@Param('id')可以将传的param参数id赋值给形参,然后使用@param('id')可以将传的参数参数id赋值给形参,然后使用
3、DTO 的概念数据传输对象(DTO)
(DataTransferObject),是一种设计模式之间传输数据的软件应用系统。数据传输目标往往是数据访问对象从数据库中检索数据。数据传输对象与数据交互对象或数据访问对象之间的差异是一个以不具有任何行为除了存储和检索的数据(访问和存取器)。
-
我们可以在users的createdto中对我们想要增加的类型结构进行限制,
-
我们可以在用户的创建中对我们想要增加的类型结构进行限制,
// create-user.dto.ts import { ApiProperty } from '@nestjs/swagger'
export class CreateUserDto {
@ApiProperty({example: '18625112911'}) phoneNumber: string; @ApiProperty({example: '666'}) password: string; @ApiProperty({example: '123@qq.com'}) email: string;}
-
我们的接口文档也会发生相应的变化,可以用
@ApiProperty注解来给文档加个示例 -
我们的接口文档也会发生相应的变化,可以用
@ApiProperty注解来给文档加个示例
-
还可以对响应结构进行限定, 用 ApiResponse 注解
// users.controller.ts @Post() @ApiOperation({ summary: '新增用户', }) @ApiResponse({ status: HttpStatus.CREATED, type: CreateUserDto }) @ApiBearerAuth() create(@Body() createUserDto: CreateUserDto) { return this.usersService.create(createUserDto); }