Guide
OpenAPI와 schema artifacts
Provider registry에서 생성되는 ApiFuse OpenAPI 3.1 문서와 Developer schema bundle을 사용하는 방법입니다.
Registry 기반 OpenAPI 3.1과 schema artifacts
ApiFuse API Reference와 Gateway MCP의 apifuse_dev_* tool은 Gateway가 로드한 Provider Metadata API projection을 사용합니다. OpenAPI, provider catalog, developer schema bundle은 bun run build:provider-registry로 생성되는 단일 metadata projection에 함께 포함되며 Gateway가 서명 검증 후 제공합니다.
엔드포인트
| 위치 | 설명 |
|---|---|
/docs/api | provider별 Scalar API Reference |
/docs/api/{providerId} | 단일 provider로 필터링된 API Reference |
/api/openapi.json | platform 전체 OpenAPI JSON |
https://apifuse.com/api/mcp | Platform proxy to Gateway MCP; use apifuse_dev_* tools for catalog and schema bundles |
Gateway path 형식
모든 provider operation은 다음 형식으로 문서화됩니다. API Reference Try it out도 같은 path shape를 표시하지만, 브라우저 요청은 안전한 same-origin proxy인 /api/proxy/call/v1/{providerId}/{operationId}를 거쳐 server-side demo key 또는 검증된 Connection auth로 Gateway에 전달됩니다.
POST /v1/{providerId}/{operationId}예시:
POST /v1/kma-forecast/short-forecast
POST /v1/law-service/searchSchema bundle contents
Operation schema bundle은 다음 정보를 포함합니다.
- input/output JSON Schema
- OpenAPI operation fragment
- TypeScript input/output types
- Zod input/output schemas
- Pydantic v2 input/output models
- example request/response
- auth mode와 authorization 요구사항
- schema, target artifact, bundle hash
- lossy conversion warning
재생성
Provider registry를 변경한 경우 다음 명령으로 signed projection 입력과 metadata projection artifact를 갱신합니다.
bun run build:provider-registryCI에서는 다음 check로 drift를 검증합니다.
bun run scripts/build-provider-registry.ts --check