가이드
OpenAPI 스펙
모든 API에 자동 생성되는 OpenAPI 3.1 스펙을 사용하는 방법을 안내합니다.
모든 API에 OpenAPI 3.1 스펙 자동 제공
ApiFuse의 모든 API에 대해 OpenAPI 3.1 스펙이 자동 생성됩니다. 별도 문서를 찾을 필요 없이, 표준화된 스키마로 AI 에이전트, SDK 자동 생성, API 클라이언트 도구와 바로 연동할 수 있어요.
누가 쓰나요?
- AI 에이전트 — MCP를 통해 API 스펙을 자동 파악하고 호출
- SDK 생성 도구 — OpenAPI Generator로 클라이언트 자동 생성
- API 클라이언트 — Postman, Insomnia에서 컬렉션 임포트
- 타입 생성 — TypeScript 타입을 스키마에서 자동 생성
엔드포인트
GET /api/{api-id}/openapi예시
GET /api/kma-forecast/openapi 요청 시:
{
"openapi": "3.1.0",
"info": {
"title": "기상청 단기예보 API",
"version": "1.0"
},
"paths": {
"/getVilageFcst": {
"get": {
"summary": "동네 예보 조회",
"parameters": [
{ "name": "base_date", "in": "query", "required": true },
{ "name": "nx", "in": "query", "required": true },
{ "name": "ny", "in": "query", "required": true }
]
}
}
}
}각 API 상세 페이지에서 "OpenAPI Spec" 버튼으로도 접근할 수 있습니다. 모든 스펙은 Zod 스키마에서 자동 생성되므로 항상 최신 상태를 유지합니다.