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

docs: API 문서화 #122

Merged
merged 2 commits into from
Sep 22, 2023
Merged

docs: API 문서화 #122

merged 2 commits into from
Sep 22, 2023

Conversation

pushedrumex
Copy link
Member

⛏ 작업 사항

  • API 를 문서화하는 작업을 하였습니다.

📝 작업 요약

  • src/docs/asciidoc/index.adoc 에 API 명세를 문서화했습니다.
  • build를 하게 되면, src/main/resources/static/docs/index.html 이 생성됩니다.
  • 어플리케이션을 띄운 후, localhost:8080/docs/index.html 로 접속하여 확인할 수 있습니다.
스크린샷 2023-09-21 오후 6 16 36

💡 관련 이슈

@pushedrumex pushedrumex self-assigned this Sep 21, 2023
@github-actions
Copy link

Test Results

364 tests  ±0   364 ✔️ ±0   10s ⏱️ -1s
180 suites ±0       0 💤 ±0 
180 files   ±0       0 ❌ ±0 

Results for commit 0629641. ± Comparison against base commit b702a80.

bjo6300
bjo6300 approved these changes Sep 21, 2023
View reviewed changes
Copy link
Member

@bjo6300 bjo6300 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

고생하셨습니다!

hseong3243
hseong3243 approved these changes Sep 21, 2023
View reviewed changes
Copy link
Collaborator

@hseong3243 hseong3243 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

고생하셨습니다!

@pushedrumex pushedrumex merged commit 98e7520 into develop Sep 22, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hseong3243 hseong3243 hseong3243 approved these changes

@bjo6300 bjo6300 bjo6300 approved these changes

@funnysunny08 funnysunny08 Awaiting requested review from funnysunny08 funnysunny08 is a code owner

@seongHyun-Min seongHyun-Min Awaiting requested review from seongHyun-Min seongHyun-Min is a code owner

@Seongju-Lee Seongju-Lee Awaiting requested review from Seongju-Lee Seongju-Lee is a code owner

Assignees

@pushedrumex pushedrumex

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pushedrumex @hseong3243 @bjo6300