使用方法
- 复制安装命令，在自己的智能体环境安装前先检查源码包。
- 从原始文档核对所需工具、凭据和支持的宿主。
- 说明输入材料与期望交付物，并对照来源检查输出。
npx skills add https://github.com/xsavikx/okf-skills --skill okf-openapi开始前需了解
- 安装不包含模型订阅、API 额度或访问文件的权限。
- 仓库星数和安装量反映活跃情况，不等于独立质量或安全测试。
按源仓库内容呈现，保留标题、案例、代码、表格、链接以及原文引用的演示图片。
OpenAPI OKF Connector
This skill provides a Go-based CLI tool to document an OpenAPI/Swagger specification as an Open Knowledge Format (OKF) bundle: one API Endpoint concept per operation and one Schema concept per component schema, with endpoints linked to the schemas they reference. It needs only the spec file — no live server, no credentials.
When to Use
Use this skill when you need to:
- Catalog an HTTP API from its OpenAPI 3.x or Swagger 2.0 contract (JSON or YAML).
- Turn endpoints and schemas into a connected, browsable graph (the endpoint→schema
references edges render as typed edges in okf-viz).
- Round-trip enriched descriptions back to a
.okf-metadata.yamlsidecar.
Setup
# Install the published binary (Go 1.24+):
go install github.com/xSAVIKx/okf-skills/skills/okf-openapi@latest
# …or build from a clone:
cd skills/okf-openapi && go build -o okf-openapi .How to Use
1. Produce an OKF bundle
./okf-openapi produce --spec <api.yaml|api.json> --out <bundle-dir>--spec(required): path to the OpenAPI 3.x or Swagger 2.0 spec (JSON or YAML;
2.0 is converted to 3.x automatically).
--out(required): output OKF bundle directory.
Each operation becomes endpoints/<operationId>.md (with parameter and response tables); each component schema becomes schemas/<Name>.md (with a # Columns property table: Name | Type | Required). Endpoints and schemas link to the schemas they reference under # Relationships. Re-running preserves enriched descriptions.
2. Ingest / sync descriptions
./okf-openapi ingest --spec <api.yaml> --bundle <bundle-dir> [--sync]- Verifies each concept still exists in the spec (reports drift); the spec file is
never modified.
--sync: writes the bundle's descriptions to.okf-metadata.yamlnext to the spec.
3. Inspect the schema (self-description)
./okf-openapi schemaPrints the machine-readable JSON description used by okf-mcp to expose the skill.
