본문으로 건너뛰기

API 참조

Swagger UI를 통해 실시간으로 API를 사용할 수 있는 방법을 제공하고 있습니다.

API 엔드포인트​


Swagger UI 사용법​

Swagger UI는 API를 탐색하고 테스트할 수 있는 사용자 친화적인 인터페이스를 제공합니다. 다음은 Swagger UI를 활용하는 방법입니다.


API 문서 탐색​

Swagger UI에서는 각 API 엔드포인트에 대한 자세한 설명과 요청/응답 형식을 확인할 수 있습니다.

  • 엔드포인트 URL: API 호출을 위한 URL 경로

  • 요청 메서드: GET, POST, PUT, DELETE 등

  • 요청 파라미터: API 호출 시 필요한 파라미터와 형식

  • 요청 전송: "Try it out" 버튼을 클릭하여 API 요청을 전송합니다.

  • 응답 형식: API 호출에 대한 응답 데이터 구조