Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Redoc기반 API 문서 배포 파이프라인 구축하기 #24

Closed
meloning opened this issue Aug 26, 2023 · 1 comment · Fixed by #32
Closed

Redoc기반 API 문서 배포 파이프라인 구축하기 #24

meloning opened this issue Aug 26, 2023 · 1 comment · Fixed by #32
Assignees
@meloning
Labels
documentation Improvements or additions to documentation feature New feature or request
Milestone
v1.1.0

Comments

@meloning
Copy link
Owner

meloning commented Aug 26, 2023 •
edited
Loading

#2 이슈를 통해 Redoc 문서 템플릿으로 generate될 수 있도록 OAS Spec에 맞게 yaml파일을 성공적으로 만들었습니다.

이제 API 문서를 보여줄 Github Pages용 저장소를 만들고, redoc cli 명령어와 Github Action workflow를 통해 문서 배포 파이프라인을 구축할려고 합니다.

(이거 끝나고 Redoc 도입과정에 대한 내용과 함께 wiki 문서를 전반적으로 깔끔하게 정리한 후, README.md 내용도 그에 맞게 변경할 예정입니다.)
@meloning meloning added this to the v1.0.0 milestone Aug 26, 2023
@meloning meloning changed the title Redoc API 문서 배포 파이프라인 구축하기 Redoc기반 API 문서 배포 파이프라인 구축하기 Aug 26, 2023
@meloning
Copy link
Owner Author

현재 Local 환경에서는 아래와 같이 별도 CLI를 통해 Redoc을 실행하고 있습니다.

Screenshot from 2023-08-27 03-14-51

@meloning meloning removed this from the v1.0.0 milestone Aug 27, 2023
@meloning meloning added documentation Improvements or additions to documentation feature New feature or request labels Aug 27, 2023
@meloning meloning added this to the v1.1.0 milestone Oct 22, 2023
@meloning meloning self-assigned this Oct 22, 2023
meloning added a commit that referenced this issue May 6, 2024
@meloning
[#24] feature: redoc document 자동화 배포 스크립트 추가
b3a088c
@meloning meloning linked a pull request May 6, 2024 that will close this issue
[#24] feature: redoc document 자동화 배포 스크립트 추가 #32
Merged
meloning added a commit that referenced this issue May 6, 2024
@meloning
Merge pull request #32 from meloning/feature/issue-24
f31884e 
[#24] feature: redoc document 자동화 배포 스크립트 추가
meloning added a commit that referenced this issue May 6, 2024
@meloning
[#24] feature: action 버전 업그레이드 및 잘못된 path 수정
3e215da
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@meloning meloning

Labels
documentation Improvements or additions to documentation feature New feature or request
Projects
None yet
Milestone
v1.1.0
1 participant
@meloning