OpenAPI 스키마
문서용 OpenAPI JSON으로 클라이언트를 만들고 요청 및 응답 형식을 검사하세요.
공개 문서에 안내된 엔드포인트와 관련 스키마를 JSON으로 제공합니다.
문서용 JSON에 포함되는 정보
문서용 OpenAPI JSON에서 플랫폼 API의 HTTP 메서드, 경로, 기본 URL, 인증 방식, 파라미터, 응답 상태와 필드 구조를 확인할 수 있습니다.
이 JSON으로 클라이언트나 타입을 생성하고, 스키마를 검사하거나 Postman 같은 API 도구에 가져올 수 있습니다. 실제 요청을 만들거나 오류를 해결할 때는 월별 사용량 또는 유닛 잔액의 조건과 예시도 확인하세요.
JSON 가져오기
문서용 OpenAPI JSON은 다음 주소에서 확인할 수 있습니다.
https://docs.platform.letsur.ai/api/platform-openapi파일로 내려받으려면 다음처럼 요청합니다.
curl --output letsur-platform-openapi.json \
'https://docs.platform.letsur.ai/api/platform-openapi'이 JSON에는 이 문서에서 검증한 엔드포인트와 그 응답에 필요한 스키마만 포함됩니다. JSON에 없는 경로를 지원되는 플랫폼 API로 간주하지 마세요.
도구에 연결할 때
- 클라이언트와 타입을 생성하기 전에 사용하는 도구가 OpenAPI 3.1을 지원하는지 확인합니다.
- Postman이나 API 검사 도구에는 문서용 JSON 주소를 입력하고, 생성된 HTTP 메서드와 기본 URL을 다시 확인합니다.
- JSON을 내려받아 클라이언트나 타입을 생성할 때는 관리 API 키가 필요하지 않습니다. 생성 도구나 검사 도구에 실제 관리 API 키를 입력하거나 스키마 파일에 키를 저장하지 마세요.
- 생성한 클라이언트로 실제 API를 호출할 때는 관리 API 키 인증을 적용합니다.
- 생성 결과가 개별 엔드포인트 문서와 다르면 문서용 OpenAPI JSON을 다시 내려받아 판본을 확인합니다.
업데이트와 검증본
최신 스키마를 확인하지 못하면 엔드포인트 문서 상단에 그 상태를 알리고 마지막으로 검증한 저장본을 제공합니다. 이때 확인되지 않은 새 엔드포인트나 필드를 추가하지 않고, 지원하지 않는 스키마 구조를 임의로 단순화하지 않습니다. 생성 결과가 실제 응답과 다르면 먼저 표시된 검증본의 판본을 확인하세요.
문서용 JSON에는 실제 관리 API 키, 스페이스 식별자, 사용량, 잔액이나 계정 데이터가 포함되지 않습니다. 외부 도구가 스키마를 저장할 수 있으므로 조직에서 승인한 도구에만 연결하세요.