API合约
将API合约附加到架构模型

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

查看定价
API合约

Contracts

Define and visualize your API surface

Create
billing-apiHTTP
user-servicegRPC
graph-apiGraphQL
eventsAsync
billing-apiv2.1.0HTTP
GET/v1/invoices
POST/v1/invoices
GET/v1/invoices/{id}
DELETE/v1/invoices/{id}
问题所在

这些痛点你再熟悉不过

这些问题会随时间不断累积。拖得越久,在工程时间和系统可靠性上付出的代价就越大。

API文档与架构分离

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

合约变更破坏消费者

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

API文档过时

OpenAPI规范在未链接时退化。

工作原理

几步即可上手

1

附加合约到C4元素

上传或粘贴schema并链接。

2

与架构一起版本化

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

3

在架构上下文中浏览API

点击容器查看其API合约。

4

通过MCP查询API

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

能力

这项功能能为你做的一切

OpenAPI, AsyncAPI, GraphQL

支持主要API规范格式。

链接到架构的API

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

版本化合约

与架构模型一起版本化。

AI可查询API

MCP工具允许访问API合约。

使用场景

团队如何使用它

01

微服务API文档

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

02

事件驱动架构

用AsyncAPI记录事件通道。

03

API治理

追踪哪些容器暴露API。

永久免费方案

与架构共存的API合约

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

  • 无需信用卡
  • 五分钟完成设置
  • 查看者始终免费

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合约