HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
🧚
[1기]최종 프로젝트 데브코스
/
🐳
[팀11] 모디
/
Swagger 문서 사용법
Swagger 문서 사용법
Swagger 문서 사용법

Swagger 문서 사용법

생성일
Dec 8, 2021 06:17 AM
태그
속성

문서링크

  • https://modi.pw/swagger-ui/index.html
  • 해당 문서는 실제 production code 기반이기 때문에 문서 내에서 이루어지는 요청과 응답은 실제 배포 서버에서 동작하는 것과 동일합니다

1. 로그인 해서 토큰 받아오기

Naver

  • 네이버의 경우 Naver Developers에 테스트 데이터로 등록되어있지 않으면 로그인이 불가능
  • 테스트 아이디를 등록해주세요!
 

Kakao

  • 누구나 로그인 가능

  • 로그인 후 url에 있는 token={토큰} 사용
    • 토큰 뒤에 있는 &userId=6 까지 가져오지 않도록 조심!
 

2. api 문서 링크로 접속

notion image
  • 각각 요청을 클릭하면 요청과 응답에 대한 형식들을 제공
 

3. Authorize

notion image
  • 우측 상단 자물쇠 모양 Authorize 클릭하면 Value값을 넣을 수 있음
  • 주의: Bearer 적고 " " 공백 후 로그인해서 받아온 토큰을 입력
  • Authorize 체크
    • notion image
    • 자물쇠가 채워진걸 확인할 수 있습니다!
 

4. Try it out

notion image
  • 모든 요청은 필요한 parameter 값을 넣어서 실제로 요청을 테스트해볼 수 있습니다.(파라미터가 필요 없는 경우도 있음)
    • notion image
    • 이런 식으로 해당 파라미터 값들을 넣고 execute를 하면
    • notion image
    • 응답을 확인할 수 있습니다!
 

5. Schemas

notion image
notion image
  • 하단에 Schemas를 확인하면 요청/응답으로 오는 변수들에 대한 설명이 적혀있습니다!
    • 안 적혀 있는 것도 있습니다...!