对比页
OKF vs OpenAPI
OpenAPI 定义机器可读的 API 契约；OKF 把 API 知识变成智能体可与规范并用的可读文件。
Open Knowledge Format (OKF)
接口说明、鉴权指引、示例、排障与 API 知识摘要。
- Markdown 加 YAML frontmatter
- 概念级文件
- 适合知识目录与智能体检索
OpenAPI
正式的请求/响应模式、代码生成、契约测试与客户端 SDK 生成。
- 保留原格式承担其核心职责
- 当知识需要元数据时再加入 OKF
- 两者解决不同检索问题时并用
推荐
让 OpenAPI 作为契约的唯一可信源，再据此生成面向智能体的 OKF 说明页。
更多 Open Knowledge Format 对比
FAQ
何时该使用 OKF vs OpenAPI？
让 OpenAPI 作为契约的唯一可信源，再据此生成面向智能体的 OKF 说明页。
Open Knowledge Format (OKF) 会取代它吗？
通常不会。OKF 更适合作为补充，让知识更易被智能体与目录消费。
最省事的起点是什么？
先用一个模板，校验通过，然后把它发布在用户已经会搜索的文档旁边。