사진찍는 개발자📸👩‍💻
close
프로필 배경
프로필 로고

사진찍는 개발자📸👩‍💻

  • 분류 전체보기 (121) N
    • develop (120) N
      • PHP (5)
      • Python (73)
      • Back-End Roadmap (1)
      • AWS (36) N
      • Java (0)
      • Nest.js (5)
    • interest (1)
      • 35mm film (1)
  • 홈
  • 태그
  • 방명록

[Nest.js] swagger 데코레이터 - 5 (타입 헬퍼)

타입 헬퍼란? 기존에 정의된 타입을 기반으로 새로운 타입을 쉽게 만들 수 있도록 도와주는 도구코드 중복을 줄이고 타입간의 일관성을 유지하는 데에 유용장점코드 중복 감소타입 안정성 보장API 문서 자동 생성유지보수 용이성일관된 DTO 구조 유지  1. PartialType()- 용도: 모든 속성을 선택적(optional)으로 만듦// 원본 DTOclass CreatePostDto { @ApiProperty() title: string; @ApiProperty() content: string; @ApiProperty() authorId: number;}// 모든 필드가 선택적으로 변환@ApiTags('posts')class UpdatePostDto extends PartialType(CreateP..

  • format_list_bulleted develop/Nest.js
  • · 2024. 12. 29.
  • textsms

[Nest.js] swagger 데코레이터 - 4 (DTO/모델)

1. @ApiProperty()- 용도: DTO나 엔티티의 속성을 Swagger 문서에 정의class CreatePostDto { @ApiProperty({ description: '게시글 제목', // 속성 설명 example: '안녕하세요', // 예시 값 required: true, // 필수 여부 type: String, // 타입 maxLength: 100, // 최대 길이 default: 'New Post', // 기본값 enum: ['DRAFT', 'PUBLISHED'], // enum 타입..

  • format_list_bulleted develop/Nest.js
  • · 2024. 12. 29.
  • textsms

[Nest.js] swagger 데코레이터 - 3 (보안)

1. @ApiPearerAuth()- 용도: JWT나 Bearer 토큰 인증을 사용하는 API를 문서화- 사용 시점: 컨트롤러 클래스 또는 메소드 레벨// main.ts에서 글로벌 설정const config = new DocumentBuilder() .setTitle('API 문서') .addBearerAuth() // Bearer 인증 활성화 .build();// 컨트롤러에서 사용@ApiBearerAuth()@UseGuards(JwtAuthGuard)@Controller('users')export class UsersController { @Get('profile') @ApiBearerAuth('JWT-auth') // 특정 보안 스키마 지정 getProfile(@Request() req..

  • format_list_bulleted develop/Nest.js
  • · 2024. 12. 29.
  • textsms

[Nest.js] swagger 데코레이터 - 2 (응답 데코레이터)

1. @ApiResponse()- 용도: 모든 유형의 API 응답을 정의할 수 있는 일반적인 데코레이터@ApiResponse({ status: 201, // HTTP 상태 코드 description: '게시글 생성 성공', // 응답 설명 type: PostResponseDto, // 응답 타입 (DTO) schema: { // 복잡한 응답 스키마 정의 시 example: { id: 1, title: '제목', content: '내용' } }}) 2. @ApiOkResponse()- 용도: 200 성공 응답 정의@ApiOkResponse..

  • format_list_bulleted develop/Nest.js
  • · 2024. 12. 29.
  • textsms

[Nest.js] swagger 데코레이터 - 1

1. @ApiOperation()- 용도: API 엔드포인트의 동작을 설명하는 메타 데이터 정의- 사용 시점: 컨트롤러의 각 메소드에 정의@ApiOperation({ summary: '게시글 목록 조회', // API 요약 설명 description: '페이지네이션을 포함한 게시글 목록을 조회합니다', // 상세 설명 deprecated: false // API 폐기 여부}) 2. @ApiTags()- 용도: API들을 논리적인 그룹으로 분류- 사용 시점: 컨트롤러 클래스 레벨에 정의// 컨트롤러 레벨에서 사용@ApiTags('posts') // 단일 태그@ApiTags('posts', 'admin') // 복수 태그@Controller('p..

  • format_list_bulleted develop/Nest.js
  • · 2024. 12. 29.
  • textsms
  • navigate_before
  • 1
  • navigate_next
공지사항
전체 카테고리
  • 분류 전체보기 (121) N
    • develop (120) N
      • PHP (5)
      • Python (73)
      • Back-End Roadmap (1)
      • AWS (36) N
      • Java (0)
      • Nest.js (5)
    • interest (1)
      • 35mm film (1)
최근 글
인기 글
최근 댓글
태그
  • #파이썬
  • #SAA
  • #프로그래머스 파이썬
  • #aws
  • #프로그래머스
  • #Python
  • #nest swagger
  • #nest swagger 데코레이터
  • #swagger 데코레이터
  • #SAA자격증
전체 방문자
오늘
어제
전체
Copyright © 쭈미로운 생활 All rights reserved.
Designed by JJuum

티스토리툴바