Skip to content

Comments

add : api document 기초 세팅#26

Merged
myqewr merged 1 commit intodevelopfrom
feature/#25
Mar 20, 2025
Merged

add : api document 기초 세팅#26
myqewr merged 1 commit intodevelopfrom
feature/#25

Conversation

@myqewr
Copy link
Member

@myqewr myqewr commented Mar 20, 2025

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • api 문서화 기본 템플릿 작성 : index.adoc 생성
  • custom snippet template 생성
  • swagger 문서화 authorization 생성안되는 문제 해결

🔍 참고사항

  • swagger 문서 authorization 부분에서 session id 전달하는 방식은 추후 security 설정 완료 후 제대로 다시 작성 후 테스트 필요해보입니다. 어느 부분에 session값 담아서 전달하기로 했는지 확인이 안돼서 가장 기본적인 형태로 작성해놨습니다.
  • header에 담기기는 하는데, swagger에서 테스트시 브라우저랑 호환되는 것 관련 문제가 있을 수 있어서 나중에 다시 완전히 수정하도록 하겠습니다.

📚 기타

@myqewr myqewr self-assigned this Mar 20, 2025
@myqewr myqewr merged commit 16c3344 into develop Mar 20, 2025
1 check passed
@hisonghy hisonghy added the 📄 documentation 문서 작업 label Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📄 documentation 문서 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📄 API 문서화 수정

2 participants