feature: Swagger API 명세 추가

[Combi153]

📌 관련 이슈

• closed feature: Swagger API 명세 추가 #30

📁 작업 설명

• Swagger API 명세 설정 추가했습니다!

참고

Swagger에서 Auth 관련 API 들은 테스트할 수 없거나 힘듭니다. 따라서 Auth 관련 API 들은 Hidden 처리했습니다.

1. /auth/Kakao

redirect 페이지를 로드할 수 없습니다. CORS 에러를 마주하게 됩니다.

2. /auth/login/Kakao

카카오에서 전달해주는 auth code를 받을 수 없습니다.

3. /auth/token

Swagger UI에서 refreshToken 을 서버에게 cookie로 전달할 수 없습니다. 다음 자료를 참고해주세요.

• Cookie not sent through swagger ui fastapi/fastapi#880
• https://swagger.io/docs/specification/authentication/cookie-authentication/

Note for Swagger UI and Swagger Editor users: Cookie authentication is currently not supported for "try it out" requests due to browser security restrictions. See this issue for more information. SwaggerHub does not have this limitation.

기타

• 각자 localhost 에서 테스트 해보셔도 좋을 것 같습니다!

[TaeyeonRoyce]

스웨거도 이렇게 구성하니깐 UI가 깔끔하고 잘 보여지네요!
너무 고생하셨습니다..!👍

[github-actions]

Test Results

 20 files  ±0   20 suites  ±0   6s ⏱️ ±0s
 71 tests ±0   71 ✅ ±0  0 💤 ±0  0 ❌ ±0 
102 runs  ±0  102 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit fe15821. ± Comparison against base commit 7971059.

♻️ This comment has been updated with latest results.

[hgo641]

스웨거 처음 써봐서 신기하네요! 어프루브합니다!!