사용 방법
- 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
- 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
- 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
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.
