API契约与事件通道 - 记录接口

记录与C4架构关联的API契约和事件通道。追踪规格、版本和关系。

api-contracts

FileCode

将API合约附加到架构模型

将OpenAPI、AsyncAPI或GraphQL schema直接附加到C4容器和组件。

API合约管理 | Archyl

将OpenAPI、AsyncAPI和GraphQL附加到C4元素。

API合约管理, OpenAPI架构

TriangleAlert

API文档与架构分离

API合约在Swagger UI中,架构图在其他地方。

合约变更破坏消费者

不知道哪些团队消费哪些API。

RefreshCw

API文档过时

OpenAPI规范在未链接时退化。

附加合约到C4元素

上传或粘贴schema并链接。

与架构一起版本化

API合约与C4模型一起版本化。

GitBranch

在架构上下文中浏览API

点击容器查看其API合约。

通过MCP查询API

AI助手通过MCP工具查询合约。

OpenAPI, AsyncAPI, GraphQL

支持主要API规范格式。

链接到架构的API

在C4模型上下文中查看API。

GitPullRequestArrow

与架构模型一起版本化。

AI可查询API

MCP工具允许访问API合约。

微服务API文档

为每个微服务容器附加OpenAPI规范。

用AsyncAPI记录事件通道。

追踪哪些容器暴露API。

与架构共存的API合约