Skip to content

8주차 미션 [도토]#33

Open
yewon20804 wants to merge 20 commits into
mainfrom
week8/doto
Open

8주차 미션 [도토]#33
yewon20804 wants to merge 20 commits into
mainfrom
week8/doto

Conversation

@yewon20804
Copy link
Copy Markdown
Collaborator

TSOA 기반 Swagger 문서화 적용

작업 사항

패키지 추가

  • swagger-ui-express, @types/swagger-ui-express 설치

src/index.ts

  • fs.readFileSync로 swagger.json 로드
  • /docs 경로에 Swagger UI 추가

src/common/responses/response.ts

  • 실패 응답 타입 ApiErrorResponse 인터페이스 추가

각 Controller (stores, reviews, missions, user-missions, users)

  • @response 데코레이터로 실패 응답 코드 문서화
  • JSDoc @summary 주석으로 엔드포인트 설명 추가

각 DTO (store, review, mission, user-mission, user)

  • Request / Response 모든 필드에 JSDoc 주석 추가

@yewon20804 yewon20804 self-assigned this May 21, 2026
@yewon20804 yewon20804 added the ✨ feature New feature or request label May 21, 2026
@yewon20804 yewon20804 linked an issue May 21, 2026 that may be closed by this pull request
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

✨ feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Week8 mission

1 participant