Cortex Docs logo

Cortex Docs

Freemium
访问

开源 API 工具工作流:将 API 规范和 Markdown 转化为交互式文档、类型化 SDK 与 MCP 服务器,统一服务开发者、应用和 AI 代理。

什么是 Cortex Docs?

Cortex Docs 是一个开源 API 工具工作流,用于根据 API 定义和 Markdown 生成多种接口。单个项目可以生成面向开发者的交互式文档、用于应用集成的类型化 SDK,以及向 AI 代理公开 API 操作的 MCP 服务器。

该工作流接受面向 REST 的 OpenAPI 规范,以及 AsyncAPI、GraphQL、gRPC 和 OpenRPC 源。Cortex Docs 会在生成前验证 API 契约,并支持在项目配置中组合多个源。使用 cortex generate 命令即可开始生成。

该产品的核心目标是,让面向用户的文档、应用客户端和面向代理的工具中的 API 知识与生成的接口保持一致。

Cortex Docs 能做什么?

多协议 API 输入

在一个项目中整合 OpenAPI、AsyncAPI、GraphQL、gRPC 和 OpenRPC 源,并在生成前验证契约。

交互式 API 文档

生成可搜索的指南、交互式参考页面、可直接复制的示例,以及供开发者探索的实时请求构建器。

类型化 SDK 生成

生成 11 种列出语言的客户端,并提供符合各语言习惯的命名、类型、身份验证、超时、流、重试和包元数据。

MCP 服务器生成

将 API 操作映射为类型化 MCP 工具,并打包规范、文档、SDK 参考和项目文档,以便 AI 代理访问。

开放模板与可部署输出

导出和覆盖 Eta 模板,将生成的包发布到所选的注册表,并在任何可运行 Node 的环境中部署文档。

使用场景

“发布面向开发者的 API 门户”

从现有 API 规范开始,生成可搜索的交互式文档,其中包含示例和请求构建器,供评估或集成 API 的用户使用。

“创建特定语言的应用客户端”

为需要跨语言使用原生客户端的应用团队生成类型化 SDK,支持 TypeScript、Python、Go、Java 或 Kotlin 等语言。

“为代理式集成准备 API”

生成 MCP 服务器,其类型化工具以及配套的规范和指南可为 AI 代理提供访问 API 操作的结构化接口。

“管理混合 API 契约”

在一个项目配置中组合 OpenAPI 和 GraphQL 等源,然后验证契约,并通过一个命令生成所选输出。

“使生成的代码适配开源工作流”

使用 MIT 许可的模板、可审查的生成流程和有选择的模板覆盖,以便团队掌控生成的代码和文档输出。

常见问题

Cortex Docs 可以生成什么?

它可以根据 API 规范和 Markdown 生成交互式 API 文档、类型化 SDK 和 MCP 服务器。这些输出分别用于开发者探索、应用集成和 AI 代理访问。

项目可以使用哪些 API 协议?

网站列出的受支持源类型包括 OpenAPI、AsyncAPI、GraphQL、gRPC 和 OpenRPC。一个项目配置中可以组合多个源。

如何运行生成?

使用包含源和 MCP 设置的 `cortex.config.yml` 文件配置项目,然后使用 `cortex generate` 开始生成。

可以自定义生成的输出吗?

可以。Cortex Docs 将其模板和语言描述为开放的,支持导出和覆盖 Eta 模板、将生成的包发布到所选注册表,并在任何可运行 Node 的环境中部署生成的文档。

Cortex Docs 是开源的吗?

该项目采用 MIT 许可并以开放方式构建。网站还链接到其公开的 GitHub 仓库,并将文档即代码和可审查的生成流程作为其工作流的一部分。

快速信息

产品类型
开源 API 工具
主要用户
开发者、应用团队和 AI 代理
输入
API 规范和 Markdown
输出
交互式文档、类型化 SDK 和 MCP 服务器
列出的源协议
OpenAPI、AsyncAPI、GraphQL、gRPC 和 OpenRPC
SDK 语言
TypeScript、Python、Go、Java、Kotlin、Ruby、PHP、C#、Rust、C++ 和 C

Cortex Docs 流量分析

流量数据仅供参考。

域名评分
3