[BUG] openAPI spec type 에러 해결 #165
Merged
Conversation
This file contains 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
|
Deploying sopt-admin with
|
| Latest commit: |
7257a47
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9b0b4caa.sopt-admin.pages.dev |
| Branch Preview URL: | https://bug-org-openapi-spec-type.sopt-admin.pages.dev |
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.
✅ PR Point
openapi-typescript를 통해 생성된 interface는 1,000 줄이 넘는 코드로 너무 복잡해서 여기서 따로 type을 추출하기 어려웠어요
따라서 type을 추출하는 아래 라이브러리를 이용해줬습니다
swagger-typescript-api
🏋🏻 실행
yarn api-spec명령어를 입력하면 자동으로 openapi spec으로 paths와 type들이 추출되도록 해놨습니다. 원래 build 시 마다 하도록 설정했는데 매번 하기엔 불필요한 거 같아서 빼줬어요🏋🏻 type들 위치
./src/ㅡㅡgeneratedㅡㅡ/org-types/data-contracts.ts에 type들이 추출되어 있어요
나머지 파일들은 각각의 API들끼리 모아놓은 파일입니다
내가 필요한 req data의 type이 뭔지 헷갈린다 하면 해당 API 파일로 가서 참고하시면 좋을 거 같아요