OpenAPI 3.1 Spec

다운로드 가능한 OpenAPI 3.1 명세. 코드 생성 (openapi-generator) + 검증 (Spectral) + Postman/Insomnia 컬렉션 import.

Last updated: 2026-04-26

Veacon API 의 모든 endpoint, 파라미터, 응답 스키마를 OpenAPI 3.1 형식으로 게시합니다.

https://veacon.io/openapi.yaml

빠른 사용

Postman / Insomnia / Bruno import

bash
curl -O https://veacon.io/openapi.yaml
# 다음 도구의 Import → File 메뉴에서 openapi.yaml 선택

Spectral 검증

bash
npm install -g @stoplight/spectral-cli
spectral lint openapi.yaml

코드 생성 (Python / TypeScript / Go / etc.)

bash
# OpenAPI Generator CLI
npx @openapitools/openapi-generator-cli generate \
  -i https://veacon.io/openapi.yaml \
  -g python \
  -o ./veacon-python-client

# 또는 Java-based:
# https://openapi-generator.tech/docs/generators

Swagger UI 로 brower view

Swagger Editor → File → Import URL → https://veacon.io/openapi.yaml

포함되는 surface

  • /api/v1/real-estate/{pulse, dimensions} — 한국 CRE aggregate (ADR-014). Layer 1-3 envelope schema 포함.
  • /api/v1/markets/{pulse, dimensions} — workspace marketplace.
  • /api/auth/me/{keys, webhooks, team, invites} — 대시보드 management endpoints. Cookie-only.
  • /api/status — 공개 uptime probe.

보안 스키마

  • apiKey — X-API-Key 헤더. B2B 고객용.
  • sessionCookie — veacon_session 쿠키. Syncle SSO 사용자용 (/auth/me/* 엔드포인트 한정).

자세한 인증 흐름은 Authentication 참조.

Versioning

Veacon 은 SemVer 를 따릅니다. Breaking change 는 major 버전 증가 (v1 → v2) 로만 도입되며, 최소 90일 deprecation 공지 후 적용됩니다.

openapi.yaml 의 info.version 필드가 현재 게시된 spec 의 버전입니다.

변경 추적

openapi.yaml 변경은 changelog 에 기록됩니다. SDK 자동 생성을 사용 중이라면 changelog 의 breaking change entry 를 모니터링하시기 바랍니다.

보안 취약점 발견

/.well-known/security.txt (RFC 9116) 또는 /trust 페이지의 vulnerability disclosure 섹션 참조.