API 문서화 #89
Merged
API 문서화 #89
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Muungi
reviewed
Nov 20, 2023
Collaborator
Muungi
left a comment
Muungi
left a comment
There was a problem hiding this comment.
고생하셨습니다! swagger를 연동하여 API 문서화가 자동화 되는 것이 매우 편리해 보이네요!
Closed
3 tasks
Muungi
reviewed
Nov 20, 2023
Muungi
approved these changes
Nov 20, 2023
Muungi
approved these changes
Nov 20, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #84
진행 내용
localhost:3000/docs로 접속하면 API 문서를 확인할 수 있습니다.NestJS의 swagger를 활용하여 API 문서를 작성했습니다. Annotation을 활용해서 간단하게 문서화 작업을 할 수 있었습니다. 이후에 작업할 때, 관련 문법을 알아두면 좋을 것 같아서 학습 링크도 남깁니다.
https://docs.nestjs.com/openapi/introduction
https://docs.nestjs.com/openapi/types-and-parameters
https://docs.nestjs.com/openapi/operations
스크린샷 (선택)