Mode d’emploi
- Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
- Consultez le document original pour les outils, identifiants et environnements requis.
- Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/xsavikx/okf-skills --skill okf-openapiAvant de commencer
- L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
- Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.
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.
