OpenAPI

센드온 SDK의 OpenAPI 사양은 API를 효율적으로 사용하고 통합할 수 있도록 설계되었습니다. OpenAPI 문서는 센드온 API의 엔드포인트, 요청 매개변수, 응답 형식, 그리고 예제 등을 포함하여 개발자가 필요한 모든 정보를 제공합니다.

OpenAPI 문서란?

OpenAPI 문서는 API의 사양을 정의한 표준화된 문서입니다. 이를 통해 개발자는 API의 구조를 이해하고, 필요한 요청을 설계하며, 응답 데이터를 처리할 수 있습니다. 센드온의 OpenAPI 문서는 Swagger UI를 통해 제공되며, 직관적이고 사용하기 쉽게 설계되었습니다.

OpenAPI 문서 링크

센드온의 OpenAPI 문서는 아래 링크에서 확인할 수 있습니다

• 🌟 센드온 OpenAPI 문서 보기

OpenAPI 문서에서 할 수 있는 작업

API 엔드포인트 탐색

• 모든 API 엔드포인트의 목록과 설명을 확인할 수 있습니다.

요청 및 응답 테스트

• Swagger UI를 통해 직접 API 요청을 테스트하고 응답을 확인할 수 있습니다.

매개변수 및 예제 확인

• 각 엔드포인트의 요청 매개변수와 예제 데이터를 참고하여 올바른 요청을 구성합니다.

자동화 도구 통합

• OpenAPI 문서를 사용하여 클라이언트 코드 생성 및 API 테스트 자동화를 수행할 수 있습니다.

사용 가이드

• 링크를 클릭하여 OpenAPI 문서에 접속합니다.
• 좌측의 API 목록에서 원하는 엔드포인트를 선택합니다.
• 엔드포인트 설명, 요청 매개변수, 응답 예제를 확인합니다.
• "Try it out" 버튼을 사용하여 실제 요청을 테스트합니다.