API 계약 및 이벤트 채널 - 인터페이스 문서화

C4 아키텍처에 연결된 API 계약과 이벤트 채널을 문서화. 사양, 버전, 관계를 추적.

api-contracts

FileCode

API 계약을 아키텍처 모델에 첨부

OpenAPI, AsyncAPI, GraphQL 스키마를 C4 컨테이너와 컴포넌트에 직접 첨부합니다.

API 계약 관리 | Archyl

OpenAPI, AsyncAPI, GraphQL을 C4 요소에 첨부합니다.

API 계약 관리, OpenAPI 아키텍처

TriangleAlert

API 문서가 아키텍처와 분리

API 계약은 Swagger UI에, 다이어그램은 다른 곳에 있습니다.

계약 변경이 소비자를 깨뜨림

어떤 팀이 어떤 API를 사용하는지 가시성이 없습니다.

RefreshCw

API 문서가 오래됨

연결되지 않은 OpenAPI 스펙이 노후화됩니다.

C4 요소에 계약 첨부

스키마를 업로드하거나 붙여넣어 연결합니다.

아키텍처와 함께 버전 관리

API 계약을 C4 모델과 함께 버전 관리합니다.

GitBranch

아키텍처 컨텍스트에서 API 탐색

컨테이너를 클릭하여 계약을 확인합니다.

MCP로 API 조회

AI 어시스턴트가 MCP 도구로 계약을 조회합니다.

OpenAPI, AsyncAPI, GraphQL

주요 API 사양 형식을 지원합니다.

아키텍처에 연결된 API

C4 모델 컨텍스트에서 API를 확인합니다.

GitPullRequestArrow

버전 관리된 계약

아키텍처 모델과 함께 버전 관리됩니다.

AI로 조회 가능한 API

MCP 도구로 API 계약에 접근합니다.

마이크로서비스 API 문서

각 마이크로서비스 컨테이너에 OpenAPI 스펙을 첨부합니다.

이벤트 기반 아키텍처

AsyncAPI로 이벤트 채널을 문서화합니다.

API 거버넌스

어떤 컨테이너가 API를 노출하는지 추적합니다.

아키텍처와 함께 살아가는 API 계약