比較ページ
OKF vs OpenAPI
OpenAPI は機械可読な API 契約を定義します。OKF は API 知識を、エージェントが仕様と併用できる読みやすいファイルにします。
Open Knowledge Format (OKF)
endpoint 説明、認証ガイド、例、トラブルシュート、API 知識の要約。
- Markdown と YAML frontmatter
- 概念単位のファイル
- カタログとエージェント検索に有用
OpenAPI
正式な request/response schema、コード生成、契約テスト、クライアント SDK 生成。
- 元の形式は本来の役割に使う
- 知識にメタデータが必要なとき OKF を追加
- 異なる検索課題を解くなら両方使う
推奨
OpenAPI を契約の source of truth にし、その上でエージェント可読な OKF 説明ページを生成します。
Open Knowledge Format の他の比較
FAQ
OKF vs OpenAPI はいつ使うべきですか？
OpenAPI を契約の source of truth にし、その上でエージェント可読な OKF 説明ページを生成します。
Open Knowledge Format (OKF) は置き換えになりますか？
通常はいいえ。OKF は、知識をエージェントやカタログが扱いやすくする補完として有効です。
最も始めやすい方法は何ですか？
まずテンプレートを使い、検証し、ユーザーがすでに検索するドキュメントの近くに公開します。