Feat: swagger api document v1 #7
Merged
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
SolfE
added
documentation
SolfE
added a commit
that referenced
this pull request
Jul 25, 2025
* Init: swagger setting (#4) * Docs: add .DS_Store git ignore * Test CICD 파이프라인 구축 (#6) * Feat: add Dockerfile * Feat: ECR ECS CICD * Fix: CICD file * Fix: CICD file * Fix: remove cache * Feat: change dev CICD pipline * Feat: swagger api document v1 (#7) * Docs: api.md v1.0 * Docs: add chunk image & chapter image * Docs: add pagination * Docs: change Swagger Config * Docs: remove useless information * Feat: global pagination & global exception handling * Docs: add error example in swagger * Docs: add single book, chapter, chunk Get API * Feat: add books controller * Docs: change progress API path * Fix: change identify _id to id * Fix: remove useless Authorization * Docs: swagger encoding to UTF-8 * Feat: add users controller * Feat: add user controller * Fix: change api.md synchronization with swagger * Fix: change swagger try it server to generated server url (#9) * Feat: init MongoDB (#12) * Docs: more specific comment about api.md currentX * Feat: init mongodb * Fix: deploy git workflow * Fix: change profile setting * Docs: add README.md * Feat: change model bookProgress (#14) * Fix: synchronized with swagger * Fix: change progress api to using chunkId, currentReadChapter * Feat: change api field about bookProgress * Feat: add books api (#16) * Fix: environment git action * Feat: add books entity * Feat: add books repository * Feat: add BookProgress entity * Feat: add BookProgress repository * Feat: add books api * Docs: add book import from aws s3 api * Docs: change import book api to using temp key * Feat: add config with s3 * Docs: add .env.local * Refactor: change difficulty to enum * Feat: add import book api * Refactor: change difficulty to enum * Feat: get chunks by difficulty * Docs: change book import json format * Feat: import Book API * Fix: add s3 env * Fix: use key way to aws credential * Fix: CICD workflow parameter syntax error * Fix: change to S3client use key * Fix: add chapter mock readtime (#19) * Feat: add health check (#21) * Fix: add chapter mock readtime * Feat: add health check * Feat: return error 404 * Feat: add user suggestion(feedback) to discord (#22) * Feat: add suggestion feat * Feat: suggestion * Feat: add discord env * Feat: calculate reading time (#24) * Fix: no require email on suggestion form (#26) * Fix: no require email on suggestion form (#28) * Fix: no require email on suggestion form (#30) * Fix: no require email on suggestion form * Fix: add default value in SuggetionRequest * Fix: swagger servers setting (#31) * Feat: add swagger server list * Feat: change branch for CICD test * Refactor: change swagger url to use properties * Feat: ECS + ECR CICD (#33) * Feat: ECS & ECR cicd * Fix: add ECR IAM * Fix: wrong working docker build directory * Fix: change prod deploy to use right env reference * Fix: wrong task-definition.json directory * Fix: git action runs-on arm64 * Fix: git action runs-on arm64 * Fix: docker buildx to arm64 * Fix: remove useless platform tag * Fix: remove useless branch tracking
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.
요약
Swagger 문서를 작성했습니다.
관련 이슈
Closes #5
구현
일관성 있는 응답을 위해서 예외처리와 Paging 응답 객체에 대한 코드를 작성하였습니다.
체크리스트
이 PR을 제출하기 전에 다음을 확인해주세요