Playground
Swagger UI를 사용하여 브라우저에서 직접 API를 테스트할 수 있습니다.
Swagger UI란?
Swagger UI는 OpenAPI 스펙을 기반으로 한 인터랙티브 API 문서입니다.
| 기능 | 설명 |
|---|---|
| 인터랙티브 테스트 | 브라우저에서 직접 API 호출 및 응답 확인 |
| 자동 문서화 | OpenAPI 스펙에서 자동 생성된 상세 문서 |
| 스키마 확인 | 요청/응답 JSON 스키마 상세 정보 |
사용 방법
Swagger UI 접속
https://openapi.meloming.com/swagger-ui/index.html 로 이동합니다.
엔드포인트 선택
테스트하려는 API 엔드포인트를 찾아 클릭합니다. 각 엔드포인트는 HTTP 메서드별로 색상이 구분됩니다.
Try it out 클릭
엔드포인트를 펼치면 “Try it out” 버튼이 보입니다. 클릭하여 테스트 모드로 전환합니다.
파라미터 입력
필수/선택 파라미터를 입력합니다. 인증이 필요한 엔드포인트는 먼저 Authorize 버튼으로 인증 정보를 설정하세요.
Execute 클릭
“Execute” 버튼을 클릭하면 실제 API가 호출되고 응답이 표시됩니다.
인증 설정하기
인증이 필요한 API를 테스트하려면:
- 페이지 상단의 Authorize 버튼을 클릭합니다
- ApiKeyAuth에
X-API-Key값을 입력하거나, BearerAuth에 OAuth Access Token을 입력합니다 - Authorize 버튼을 클릭하여 저장합니다
채널/콘텐츠 관리 API는 **BearerAuth (OAuth Access Token)**가 필요합니다.
Swagger UI에서 입력한 인증 정보는 브라우저 세션에만 저장됩니다. 페이지를 새로고침하면 다시 입력해야 합니다.
팁
GET 요청 테스트
GET 요청은 인증 없이 바로 테스트할 수 있습니다:
GET /v1/channels/1
GET /v1/channels/search?q=멜로밍
GET /v1/songs/search?q=봄날OpenAPI 스펙 다운로드
Swagger UI 페이지에서 OpenAPI JSON 스펙을 다운로드할 수 있습니다:
https://openapi.meloming.com/v3/api-docs이 스펙을 사용하여:
- 클라이언트 코드 자동 생성
- Postman 등 API 도구에 import
- 자체 문서 사이트 구축
관련 리소스
- API 레퍼런스 - 모든 엔드포인트 상세 문서
- 인증 가이드 - OAuth 2.0 및 API Key 인증 방법
- OpenAPI 스펙 - JSON 스펙 다운로드
Last updated on