Backend Openapi Documentation
Use when the user asks about OpenAPI, writing an OpenAPI spec, Swagger, openapi.yaml, spec-first design, Spectral linting, code generation or API docs hosting. Produces OpenAPI 3.1 documents with lint and CI checks. Not for endpoint semantics (use backend-api-design).
Install
npx skills add j4flmao/agent-skills --skill backend-openapi-documentationgit clone --depth 1 https://github.com/j4flmao/agent-skills.git /tmp/agent-skills
mkdir -p ~/.claude/skills
cp -r /tmp/agent-skills/skills/backend/universal/openapi-documentation ~/.claude/skills/backend-openapi-documentationPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# Backend OpenAPI Documentation
## Purpose
Drive all API development with an OpenAPI 3.x spec-first workflow: spec defines the contract, code is generated from it, and the spec is versioned alongside the code. The OpenAPI spec is the single source of truth for the API contract.
## Agent Protocol
### Trigger
Exact user phrases: "OpenAPI", "Swagger", "API documentation", "spec-first", "API spec", "openapi.yaml", "swagger.json", "codegen", "openapi-generator", "API contract first".
### Input Context
- Existing API endpoints or resource definitions.
- Chosen OpenAPI version (3.0.x or 3.1.x).
- Code generation target language.
### Output Artifact
OpenAPI YAML/JSON spec snippet or full spec file. No file unless requested.
### Response Format
```
Path: {path}
Method: {method}
OperationId: {operationId}
Tags: [{tag}]
```
### Completion Criteria
- [ ] Every endpoint has: path, method, operationId, summary, tags.
- [ ] Every request/response has a schema.
- [ ] All schemas use $ref and are not inline.
- [ ] Error responses documented.
- [ ] Security schemes defined.
- [ ] Spec passes validation (spectral or swagger-cli).
### Max Response Length
6 lines per endpoint. Unlimited for full spec.
## Architecture Decision Tree
### Spec-First vs Code-FirstDetails
- Skill name
backend-openapi-documentation- Repository
- j4flmao/agent-skills
- Path
skills/backend/universal/openapi-documentation/SKILL.md- License
- MIT
- Repo updated
- 17 November 2026
FAQ
What does the Backend Openapi Documentation skill do?
Use when the user asks about OpenAPI, writing an OpenAPI spec, Swagger, openapi.yaml, spec-first design, Spectral linting, code generation or API docs hosting. Produces OpenAPI 3.1 documents with lint and CI checks. Not for endpoint semantics (use backend-api-design).
How do I install the Backend Openapi Documentation skill?
skills CLI (Claude Code, Cursor, Codex and more): npx skills add j4flmao/agent-skills --skill backend-openapi-documentation. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is Backend Openapi Documentation popular?
It lives in j4flmao/agent-skills, which has 45 GitHub stars and 6 forks.
Related skills
Agent Observability
45j4flmao/agent-skills
Use when the user asks about agent observability, tracing agent reasoning, debugging an agent loop, OpenTelemetry GenAI spans for LLM calls, LLM cost tracking per agent, agent audit logs or hallucination/eval monitoring in production. Produces instrumentation config, trace schema, dashboards, alerts and cost attribution. Not for generic service tracing without LLMs (use devops-opentelemetry).
AI Agent Architectures
45j4flmao/agent-skills
Use when the user asks to build an AI agent, design an agent that calls tools and keeps memory, write an agent system prompt or pick an agent framework (Claude Agent SDK, OpenAI Agents SDK, LangGraph). Produces an architecture brief covering loop, tools, memory, guardrails and evals, routing depth to child skills. Not for workflow patterns (use ai-agentic-workflows).
AI Agent Core Loop
45j4flmao/agent-skills
Use when the user asks about the agent loop, ReAct vs plan-and-solve, re-planning, Reflexion, an agent stuck in a loop, max iterations or termination conditions. Produces a loop spec or patch with state, success predicate, caps and no-progress detection. Not for overall agent design (use ai-agent-architectures) or tool schemas (use tool-calling-principles).
Core Context Compressor
45j4flmao/agent-skills
Use when the user asks to compress context, summarize the conversation, save tokens, fit the context window, set a context budget or condense a long session. Produces a structured compressed summary of the session state to carry forward. Not for writing project docs (use dev-loop-readme-writer).
Asset Pipeline
45j4flmao/agent-skills
Use when the user asks about a game asset pipeline, asset cooking, import pipeline, pak files, an asset registry, hot reload or shader compilation pipeline. Produces import/cook stages, content-addressed caching and packaging. Not for runtime open-world streaming (use level-streaming).
Core Onboarding
45j4flmao/agent-skills
Use when the user asks about onboarding a new developer, new team member or new joiner, a getting started guide, dev environment setup, ramp-up plan or first-week checklist. Produces an onboarding plan and environment setup guide. Not for scaffolding a new repository (use project-init) or writing the README (use dev-loop-readme-writer).
Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.