[WIP] [backend] Set up Swagger #25
Conversation
- `docker compose exec backend yarn add @nestjs/swagger swagger-ui-express`
WalkthroughThe changes primarily focus on enhancing the NestJS backend application by integrating Swagger for API documentation and restructuring the Prisma service. The User module has been updated with DTOs and Swagger decorators, and the Prisma service has been encapsulated in its own module. Password hashing has been introduced in the User service, and the password field is now excluded from the response. Changes
Poem
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to filter (2)
- backend/package.json
- backend/yarn.lock
Files selected for processing (1)
- backend/src/main.ts (1 hunks)
Additional comments: 2
backend/src/main.ts (2)
1-3: Imports look good and are correctly placed at the top of the file.
19-19: Ensure that the
PORTenvironment variable is correctly set in your environment, and that it doesn't conflict with any other services running on the same machine.
| async function bootstrap() { | ||
| const app = await NestFactory.create(AppModule); | ||
| app.enableCors(); // enable CORS | ||
| app.setGlobalPrefix('api'); | ||
|
|
||
| const config = new DocumentBuilder() | ||
| .setTitle('Pong API') | ||
| .setDescription('The Pong API description') | ||
| .setVersion('0.1') | ||
| .build(); | ||
|
|
||
| const document = SwaggerModule.createDocument(app, config); | ||
| SwaggerModule.setup('api', app, document); | ||
|
|
||
| await app.listen(process.env.PORT); | ||
| } | ||
| bootstrap(); |
There was a problem hiding this comment.
The bootstrap function is correctly set up and the Swagger documentation is correctly configured and set up. However, it's a good practice to add error handling for the app.listen() function. This will help catch and handle any errors that might occur when the application tries to listen on the specified port.
- await app.listen(process.env.PORT);
+ try {
+ await app.listen(process.env.PORT);
+ } catch (error) {
+ console.error(`Failed to bind port ${process.env.PORT}`, error);
+ }Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| async function bootstrap() { | |
| const app = await NestFactory.create(AppModule); | |
| app.enableCors(); // enable CORS | |
| app.setGlobalPrefix('api'); | |
| const config = new DocumentBuilder() | |
| .setTitle('Pong API') | |
| .setDescription('The Pong API description') | |
| .setVersion('0.1') | |
| .build(); | |
| const document = SwaggerModule.createDocument(app, config); | |
| SwaggerModule.setup('api', app, document); | |
| await app.listen(process.env.PORT); | |
| } | |
| bootstrap(); | |
| async function bootstrap() { | |
| const app = await NestFactory.create(AppModule); | |
| app.enableCors(); // enable CORS | |
| app.setGlobalPrefix('api'); | |
| const config = new DocumentBuilder() | |
| .setTitle('Pong API') | |
| .setDescription('The Pong API description') | |
| .setVersion('0.1') | |
| .build(); | |
| const document = SwaggerModule.createDocument(app, config); | |
| SwaggerModule.setup('api', app, document); | |
| try { | |
| await app.listen(process.env.PORT); | |
| } catch (error) { | |
| console.error(`Failed to bind port ${process.env.PORT}`, error); | |
| } | |
| } | |
| bootstrap(); |
- `nest generate module prisma` - `nest generate service prisma`
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (8)
- backend/src/app.module.ts (1 hunks)
- backend/src/prisma/prisma.module.ts (1 hunks)
- backend/src/prisma/prisma.service.spec.ts (1 hunks)
- backend/src/prisma/prisma.service.ts (1 hunks)
- backend/src/user/user.controller.spec.ts (1 hunks)
- backend/src/user/user.module.ts (1 hunks)
- backend/src/user/user.service.spec.ts (1 hunks)
- backend/src/user/user.service.ts (1 hunks)
Files skipped from review due to trivial changes (2)
- backend/src/app.module.ts
- backend/src/prisma/prisma.module.ts
Additional comments: 7
backend/src/user/user.controller.spec.ts (1)
- 1-4: The import path for
PrismaServicehas been updated correctly. Ensure that the fileprisma.service.tsis indeed located in thesrc/prisma/directory.backend/src/user/user.service.spec.ts (1)
- 1-3: The import path for
PrismaServicehas been updated. Ensure that the fileprisma.service.tshas been moved to theprismadirectory and that the path is correct.- import { PrismaService } from 'src/prisma.service'; + import { PrismaService } from 'src/prisma/prisma.service';backend/src/prisma/prisma.service.ts (2)
1-2: The import statements are correct and necessary for the PrismaService class.
4-5: The
PrismaServiceclass is correctly decorated with@Injectable(), which allows it to be managed by NestJS's dependency injection system. It also correctly extendsPrismaClient, which provides access to your database via Prisma.backend/src/user/user.module.ts (1)
- 1-11: The changes look good. The
PrismaModuleis now being imported instead ofPrismaService, which is the correct way to use Prisma with NestJS. ThePrismaModuleis also added to theimportsarray in the@Moduledecorator, which is necessary for dependency injection. ThePrismaServiceis no longer provided directly in this module, which is also correct because it will be provided by thePrismaModule.backend/src/prisma/prisma.service.spec.ts (1)
- 1-18: The test case is well written and follows the standard structure of a unit test in NestJS. It correctly imports the necessary modules and services, sets up the testing module, and checks if the service is defined. However, it would be beneficial to add more test cases to verify the functionality of the
PrismaServicemethods.+ it('should perform some operation', async () => { + const result = await service.someOperation(); + expect(result).toBe(expectedResult); + });backend/src/user/user.service.ts (1)
- 1-6: The import statement for
PrismaServicehas been updated. Ensure that the file path is correct and thePrismaServicefile is located at'src/prisma/prisma.service'.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (4)
- backend/src/user/dto/create-user.dto.ts (1 hunks)
- backend/src/user/entities/user.entity.ts (1 hunks)
- backend/src/user/user.controller.ts (1 hunks)
- backend/src/user/user.service.ts (1 hunks)
Additional comments: 4
backend/src/user/dto/create-user.dto.ts (1)
- 1-12: The changes look good. The
ApiPropertydecorator is used correctly to provide metadata for Swagger to generate the API documentation. Therequiredoption is used correctly to indicate that thenameproperty is optional. However, it's important to ensure that the password is stored securely and not returned in any API responses. Also, consider adding validation decorators from theclass-validatorpackage to enforce data integrity.import { ApiProperty } from '@nestjs/swagger'; import { IsEmail, IsOptional, IsString, MinLength } from 'class-validator'; export class CreateUserDto { @ApiProperty() @IsEmail() email: string; @ApiProperty({ required: false }) @IsOptional() @IsString() name?: string; @ApiProperty() @IsString() @MinLength(8) password: string; }backend/src/user/user.controller.ts (1)
- 8-55: The Swagger decorators are correctly used to document the API endpoints. The
@ApiTags,@ApiCreatedResponse,@ApiOkResponse, and@ApiNoContentResponsedecorators are used appropriately to describe the endpoints, their responses, and to group them under the 'user' tag. The DTOs and theUserEntityare also correctly used in the decorators to describe the shape of the data. However, ensure that theUserEntityaccurately represents the shape of the user data.backend/src/user/user.service.ts (2)
23-25: The
findOnemethod has been updated to usefindUniqueinstead offindFirst. This is a good change, asfindUniqueis more appropriate for finding a record by its unique identifier.27-31: The
updatemethod has been updated to useupdateUserDtoinstead ofdata. This is a good change, as it makes the method signature more explicit and easier to understand.
| import { User } from '@prisma/client'; | ||
| import { ApiProperty } from '@nestjs/swagger'; | ||
|
|
||
| export class UserEntity implements User { | ||
| @ApiProperty() | ||
| id: number; | ||
|
|
||
| @ApiProperty() | ||
| email: string; | ||
|
|
||
| @ApiProperty({ required: false, nullable: true }) | ||
| name: string | null; | ||
|
|
||
| @ApiProperty() | ||
| password: string; | ||
| } |
There was a problem hiding this comment.
The UserEntity class is correctly implementing the User interface and the ApiProperty decorators are correctly used to provide API documentation. However, it's not a good practice to expose sensitive data like passwords in the API documentation. Consider removing the ApiProperty decorator from the password field.
- @ApiProperty()
password: string;Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| import { User } from '@prisma/client'; | |
| import { ApiProperty } from '@nestjs/swagger'; | |
| export class UserEntity implements User { | |
| @ApiProperty() | |
| id: number; | |
| @ApiProperty() | |
| email: string; | |
| @ApiProperty({ required: false, nullable: true }) | |
| name: string | null; | |
| @ApiProperty() | |
| password: string; | |
| } | |
| import { User } from '@prisma/client'; | |
| import { ApiProperty } from '@nestjs/swagger'; | |
| export class UserEntity implements User { | |
| @ApiProperty() | |
| id: number; | |
| @ApiProperty() | |
| email: string; | |
| @ApiProperty({ required: false, nullable: true }) | |
| name: string | null; | |
| - // @ApiProperty() | |
| password: string; | |
| } |
| } | ||
|
|
||
| @Delete(':id') | ||
| @ApiNoContentResponse() | ||
| remove(@Param('id') id: string) { | ||
| return this.userService.remove(+id); |
There was a problem hiding this comment.
The +id operation is used to convert the id from a string to a number. If the id is not a number, this operation will return NaN, which could lead to unexpected behavior. If the id is expected to be a number, it would be better to parse it with parseInt(id, 10) and handle the case where id is not a number. If the id is not expected to be a number, the + operation should be removed.
- return this.userService.findOne(+id);
+ return this.userService.findOne(parseInt(id, 10));Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| return this.userService.remove(+id); | |
| return this.userService.findOne(parseInt(id, 10)); |
backend/src/user/user.service.ts
Outdated
| async create(createUserDto: CreateUserDto): Promise<User> { | ||
| const saltRounds = 10; | ||
| const hashedPassword = await bcrypt.hash(data.password, saltRounds); | ||
| data.password = hashedPassword; | ||
| return this.prisma.user.create({ data }); | ||
| const hashedPassword = await bcrypt.hash(createUserDto.password, saltRounds); | ||
| createUserDto.password = hashedPassword; | ||
| return this.prisma.user.create({ data: createUserDto }); | ||
| } |
There was a problem hiding this comment.
The password is being hashed before being stored, which is a good security practice. However, directly modifying the createUserDto object to replace the password with the hashed password is not recommended. It's better to create a new object for the data to be stored, to avoid potential side effects from modifying the input object.
- createUserDto.password = hashedPassword;
- return this.prisma.user.create({ data: createUserDto });
+ const userData = { ...createUserDto, password: hashedPassword };
+ return this.prisma.user.create({ data: userData });Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| async create(createUserDto: CreateUserDto): Promise<User> { | |
| const saltRounds = 10; | |
| const hashedPassword = await bcrypt.hash(data.password, saltRounds); | |
| data.password = hashedPassword; | |
| return this.prisma.user.create({ data }); | |
| const hashedPassword = await bcrypt.hash(createUserDto.password, saltRounds); | |
| createUserDto.password = hashedPassword; | |
| return this.prisma.user.create({ data: createUserDto }); | |
| } | |
| async create(createUserDto: CreateUserDto): Promise<User> { | |
| const saltRounds = 10; | |
| const hashedPassword = await bcrypt.hash(createUserDto.password, saltRounds); | |
| const userData = { ...createUserDto, password: hashedPassword }; | |
| return this.prisma.user.create({ data: userData }); | |
| } |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- backend/src/user/user.service.ts (1 hunks)
Additional comments: 3
backend/src/user/user.service.ts (3)
1-6: Imports look good and are correctly ordered. The
hashfunction is imported directly frombcryptwhich is a good practice as it only imports what is needed.23-25: The
findOnefunction now usesfindUniqueinstead offindFirst. This is a good change asfindUniqueis more appropriate when searching by ID.27-32: The
updatefunction now accepts anUpdateUserDtoobject. Ensure that all calls to this function throughout the codebase have been updated to match the new signature.
backend/src/user/user.service.ts
Outdated
| async create(createUserDto: CreateUserDto): Promise<User> { | ||
| const saltRounds = 10; | ||
| const hashedPassword = await bcrypt.hash(data.password, saltRounds); | ||
| data.password = hashedPassword; | ||
| return this.prisma.user.create({ data }); | ||
| const hashedPassword = await hash(createUserDto.password, saltRounds); | ||
| createUserDto.password = hashedPassword; | ||
| return this.prisma.user.create({ data: createUserDto }); | ||
| } |
There was a problem hiding this comment.
The create function now accepts a CreateUserDto object and uses the hash function to hash the password. This is a good security practice. However, it's important to note that the createUserDto object is being mutated here. If this object is used elsewhere after this function call, it might lead to unexpected behavior. Consider creating a copy of the object before mutating it.
async create(createUserDto: CreateUserDto): Promise<User> {
const saltRounds = 10;
const hashedPassword = await hash(createUserDto.password, saltRounds);
- createUserDto.password = hashedPassword;
+ const userDtoWithHashedPassword = { ...createUserDto, password: hashedPassword };
- return this.prisma.user.create({ data: createUserDto });
+ return this.prisma.user.create({ data: userDtoWithHashedPassword });
}Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| async create(createUserDto: CreateUserDto): Promise<User> { | |
| const saltRounds = 10; | |
| const hashedPassword = await bcrypt.hash(data.password, saltRounds); | |
| data.password = hashedPassword; | |
| return this.prisma.user.create({ data }); | |
| const hashedPassword = await hash(createUserDto.password, saltRounds); | |
| createUserDto.password = hashedPassword; | |
| return this.prisma.user.create({ data: createUserDto }); | |
| } | |
| async create(createUserDto: CreateUserDto): Promise<User> { | |
| const saltRounds = 10; | |
| const hashedPassword = await hash(createUserDto.password, saltRounds); | |
| const userDtoWithHashedPassword = { ...createUserDto, password: hashedPassword }; | |
| return this.prisma.user.create({ data: userDtoWithHashedPassword }); | |
| } |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (2)
- backend/src/prisma/prisma.module.ts (1 hunks)
- backend/src/user/user.controller.ts (1 hunks)
Files skipped from review due to trivial changes (1)
- backend/src/prisma/prisma.module.ts
Additional comments: 4
backend/src/user/user.controller.ts (4)
8-19: The import statements are well organized and the necessary modules are imported for Swagger documentation.
22-23: The
@ApiTags('user')decorator is correctly used to categorize the API endpoints under the 'user' tag in the Swagger UI.27-31: The
createmethod is correctly decorated with@ApiCreatedResponse({ type: UserEntity })to indicate the response schema in the Swagger UI. The method signature is updated to acceptcreateUserDtoof typeCreateUserDto.33-37: The
findAllmethod is correctly decorated with@ApiOkResponse({ type: [UserEntity] })to indicate the response schema in the Swagger UI.
| @Get(':id') | ||
| @ApiOkResponse({ type: UserEntity }) | ||
| findOne(@Param('id') id: string) { | ||
| return this.userService.findOne(+id); | ||
| } |
There was a problem hiding this comment.
The findOne method is correctly decorated with @ApiOkResponse({ type: UserEntity }) to indicate the response schema in the Swagger UI. However, the +id operation is used to convert the id from a string to a number. If the id is not a number, this operation will return NaN, which could lead to unexpected behavior. If the id is expected to be a number, it would be better to parse it with parseInt(id, 10) and handle the case where id is not a number. If the id is not expected to be a number, the + operation should be removed.
- return this.userService.findOne(+id);
+ return this.userService.findOne(parseInt(id, 10));Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| @Get(':id') | |
| @ApiOkResponse({ type: UserEntity }) | |
| findOne(@Param('id') id: string) { | |
| return this.userService.findOne(+id); | |
| } | |
| @Get(':id') | |
| @ApiOkResponse({ type: UserEntity }) | |
| findOne(@Param('id') id: string) { | |
| return this.userService.findOne(parseInt(id, 10)); | |
| } |
| @Patch(':id') | ||
| update( | ||
| @Param('id') id: string, | ||
| @Body() userData: { name?: string; email?: string; password?: string }, | ||
| ) { | ||
| return this.userService.update(+id, userData); | ||
| @ApiOkResponse({ type: UserEntity }) | ||
| update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) { | ||
| return this.userService.update(+id, updateUserDto); | ||
| } |
There was a problem hiding this comment.
The update method is correctly decorated with @ApiOkResponse({ type: UserEntity }) to indicate the response schema in the Swagger UI. The method signature is updated to accept updateUserDto of type UpdateUserDto. The same issue with the +id operation as in the findOne method applies here.
- return this.userService.update(+id, updateUserDto);
+ return this.userService.update(parseInt(id, 10), updateUserDto);Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| @Patch(':id') | |
| update( | |
| @Param('id') id: string, | |
| @Body() userData: { name?: string; email?: string; password?: string }, | |
| ) { | |
| return this.userService.update(+id, userData); | |
| @ApiOkResponse({ type: UserEntity }) | |
| update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) { | |
| return this.userService.update(+id, updateUserDto); | |
| } | |
| @Patch(':id') | |
| @ApiOkResponse({ type: UserEntity }) | |
| update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) { | |
| return this.userService.update(parseInt(id, 10), updateUserDto); | |
| } |
| @Delete(':id') | ||
| @ApiNoContentResponse() | ||
| remove(@Param('id') id: string) { | ||
| return this.userService.remove(+id); | ||
| } |
There was a problem hiding this comment.
The remove method is correctly decorated with @ApiNoContentResponse() to indicate that no content is returned in the response. The same issue with the +id operation as in the findOne method applies here.
- return this.userService.remove(+id);
+ return this.userService.remove(parseInt(id, 10));Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| @Delete(':id') | |
| @ApiNoContentResponse() | |
| remove(@Param('id') id: string) { | |
| return this.userService.remove(+id); | |
| } | |
| @Delete(':id') | |
| @ApiNoContentResponse() | |
| remove(@Param('id') id: string) { | |
| return this.userService.remove(parseInt(id, 10)); | |
| } |
- to avoid potential side effects from modifying the input object.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 4
Configuration used: CodeRabbit UI
Files selected for processing (4)
- backend/src/user/dto/update-user.dto.ts (1 hunks)
- backend/src/user/entities/user.entity.ts (1 hunks)
- backend/src/user/user.controller.ts (1 hunks)
- backend/src/user/user.service.ts (1 hunks)
Additional comments: 8
backend/src/user/dto/update-user.dto.ts (1)
- 1-4: The change from
@nestjs/mapped-typesto@nestjs/swaggerforPartialTypeis correct. This is becausePartialTypehas been moved to@nestjs/swaggerin newer versions of NestJS. Ensure that the version of NestJS being used supports this change.- import { PartialType } from '@nestjs/mapped-types'; + import { PartialType } from '@nestjs/swagger';backend/src/user/entities/user.entity.ts (1)
- 1-15: The
UserEntityclass is correctly implementing theUserinterface from@prisma/client. TheApiPropertydecorator is used appropriately to document the API. However, thepasswordfield is not decorated withApiProperty. If this is intentional (for example, to avoid exposing sensitive data in the API documentation), it's fine. Otherwise, consider adding the decorator for consistency.+ @ApiProperty({ required: false }) password: string;Also, ensure that the
passwordfield is not returned in API responses to avoid exposing sensitive data. This can be done in the service layer when mapping the data to DTOs.backend/src/user/user.service.ts (2)
1-57: The changes in this file are well-structured and follow best practices. The use of DTOs for data transfer, the exclusion of password fields from the returned user data, and the use of bcrypt for password hashing are all good security practices. The use of Prisma for database operations is also a good choice for type safety and developer productivity.
19-24: Ensure that the
saltRoundsvalue is appropriate for your security requirements. A higher value will increase the time taken to hash the password, which can slow down the response time of your API, but it will also make the hashed password more secure.backend/src/user/user.controller.ts (4)
8-19: The import statements are well organized and the Swagger decorators are correctly imported.
22-24: The
UserControllerclass is correctly decorated with@ApiTags('user')for Swagger documentation.27-31: The
createmethod is correctly decorated with@ApiCreatedResponse({ type: UserEntity })to indicate the response schema in the Swagger UI.33-37: The
findAllmethod is correctly decorated with@ApiOkResponse({ type: [UserEntity] })to indicate the response schema in the Swagger UI.
| update( | ||
| id: number, | ||
| updateUserDto: UpdateUserDto, | ||
| ): Promise<UserWithoutPassword> { | ||
| return this.prisma.user | ||
| .update({ | ||
| where: { id: id }, | ||
| data: updateUserDto, | ||
| }) | ||
| .then(excludePassword); | ||
| } |
There was a problem hiding this comment.
In the update function, if the updateUserDto contains a new password, it should be hashed before being stored in the database. This is not currently being done. Here's a proposed fix:
update(
id: number,
updateUserDto: UpdateUserDto,
): Promise<UserWithoutPassword> {
+ if (updateUserDto.password) {
+ const saltRounds = 10;
+ updateUserDto.password = await hash(updateUserDto.password, saltRounds);
+ }
return this.prisma.user
.update({
where: { id: id },
data: updateUserDto,
})
.then(excludePassword);
}Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| update( | |
| id: number, | |
| updateUserDto: UpdateUserDto, | |
| ): Promise<UserWithoutPassword> { | |
| return this.prisma.user | |
| .update({ | |
| where: { id: id }, | |
| data: updateUserDto, | |
| }) | |
| .then(excludePassword); | |
| } | |
| update( | |
| id: number, | |
| updateUserDto: UpdateUserDto, | |
| ): Promise<UserWithoutPassword> { | |
| if (updateUserDto.password) { | |
| const saltRounds = 10; | |
| updateUserDto.password = await hash(updateUserDto.password, saltRounds); | |
| } | |
| return this.prisma.user | |
| .update({ | |
| where: { id: id }, | |
| data: updateUserDto, | |
| }) | |
| .then(excludePassword); | |
| } |
| findOne(@Param('id') id: string) { | ||
| return this.userService.findOne(+id); | ||
| } |
There was a problem hiding this comment.
The +id operation is used to convert the id from a string to a number. If the id is not a number, this operation will return NaN, which could lead to unexpected behavior. If the id is expected to be a number, it would be better to parse it with parseInt(id, 10) and handle the case where id is not a number. If the id is not expected to be a number, the + operation should be removed.
- return this.userService.findOne(+id);
+ return this.userService.findOne(parseInt(id, 10));Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| findOne(@Param('id') id: string) { | |
| return this.userService.findOne(+id); | |
| } | |
| findOne(@Param('id') id: string) { | |
| return this.userService.findOne(parseInt(id, 10)); | |
| } |
| update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) { | ||
| return this.userService.update(+id, updateUserDto); | ||
| } |
There was a problem hiding this comment.
The same issue with the +id operation as in the findOne method applies here.
- return this.userService.update(+id, updateUserDto);
+ return this.userService.update(parseInt(id, 10), updateUserDto);Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) { | |
| return this.userService.update(+id, updateUserDto); | |
| } | |
| update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) { | |
| return this.userService.update(parseInt(id, 10), updateUserDto); | |
| } |
| remove(@Param('id') id: string) { | ||
| return this.userService.remove(+id); | ||
| } |
There was a problem hiding this comment.
The same issue with the +id operation as in the findOne method applies here.
- return this.userService.remove(+id);
+ return this.userService.remove(parseInt(id, 10));Commitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| remove(@Param('id') id: string) { | |
| return this.userService.remove(+id); | |
| } | |
| remove(@Param('id') id: string) { | |
| return this.userService.remove(parseInt(id, 10)); | |
| } |
とりあえず表示できるように。
http://localhost:4242/api
Prisma公式ブログの中にあったチュートリアルPart1を参考にbackendを修正しました。
This article will teach you how to build a backend REST API with NestJS, Prisma, PostgreSQL and Swagger.とのことだったのですごくちょうどよかった。https://www.prisma.io/blog/nestjs-prisma-rest-api-7D056s1BmOL0#define-get-articles-endpoint
Summary by CodeRabbit
findUniqueinstead offindFirstfor more accurate user retrieval.