Generate, maintain, and validate OpenAPI 3.1 specifications for RESTful APIs.
Works with
Supports design-first, code-first, and hybrid approaches with templates for complete specs, FastAPI/Python generation, and TypeScript/Express decorators
Includes reusable components for schemas, parameters, responses, and security schemes to minimize duplication across endpoints
Provides Spectral and Redocly validation rules to enforce naming conventions, security requirements, and documentation standards \
AI-first code editor with Composer
Before installing skills in Cursor, ensure your development environment meets these requirements:
node --versionopenapi-spec-generationExecute the skills CLI command in your project's root directory to begin installation:
Fetches openapi-spec-generation from wshobson/agents and configures it for Cursor.
The CLI shows a list of agents. Use arrow keys and space to select Cursor:
Confirm successful installation by checking the skill directory location:
Restart Cursor to activate openapi-spec-generation. Access via /openapi-spec-generation in your agent's command palette.
We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.
Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.
Submit your Claude Code skill and start earning
Automate repetitive workflows and reduce manual effort
Example
Generate reports, summarize documents, draft communications
Save 3-5 hours per week on routine tasks
Learn new skills, understand complex topics, get expert guidance
Example
Explain concepts, provide examples, suggest learning resources
Accelerate learning and skill development by 2x
Enhance output quality through reviews, suggestions, and refinements
Example
Review drafts, suggest improvements, catch errors
Improve work quality by 30-40% with less effort
0
total installs
0
this week
33.1K
GitHub stars
0
upvotes
Run in your terminal
0
installs
0
this week
33.1K
stars
Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.
openapi: 3.1.0
info:
title: API Title
version: 1.0.0
servers:
- url: https://api.example.com/v1
paths:
/resources:
get: ...
components:
schemas: ...
securitySchemes: ...
| Approach | Description | Best For |
|---|---|---|
| Design-First | Write spec before code | New APIs, contracts |
| Code-First | Generate spec from code | Existing APIs |
| Hybrid | Annotate code, generate spec | Evolving APIs |
openapi: 3.1.0
info:
title: User Management API
description: |
API for managing users and their profiles.
## Authentication
All endpoints require Bearer token authentication.
## Rate Limiting
- 1000 requests per minute for standard tier
- 10000 requests per minute for enterprise tier
version: 2.0.0
contact:
name: API Support
email: api-[email protected]
url: https://docs.example.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: https://api.example.com/v2
description: Production
- url: https://staging-api.example.com/v2
description: Staging
- url: http://localhost:3000/v2
description: Local development
tags:
- name: Users
description: User management operations
- name: Profiles
description: User profile operations
- name: Admin
description: Administrative operations
paths:
/users:
get:
operationId: listUsers
summary: List all users
description: Returns a paginated list of users with optional filtering.
tags:
- Users
parameters:
- $ref: "#/components/parameters/PageParam"
- $ref: "#/components/parameters/LimitParam"
- name: status
in: query
description: Filter by user status
schema:
$ref: "#/components/schemas/UserStatus"
- name: search
in: query
description: Search by name or email
schema:
type: string
minLength: 2
maxLength: 100
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: "#/components/schemas/UserListResponse"
examples:
default:
$ref: "#/components/examples/UserListExample"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"429":
$ref: "#/components/responses/RateLimited"
security:
- bearerAuth: []
post:
operationId: createUser
summary: Create a new user
description: Creates a new user account and sends welcome email.
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateUserRequest"
examples:
standard:
summary: Standard user
value:
email: [email protected]
name: John Doe
role: user
admin:
summary: Admin user
value:
email: [email protected]
name: Admin User
role: admin
responses:
"201":
description: User created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/User"
headers:
Location:
description: URL of created user
schema:
type: string
format: uri
"400":
$ref: "#/components/responses/BadRequest"
"409":
description: Email already exists
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
security:
- bearerAuth: []
/users/{userId}:
parameters:
- $ref: "#/components/parameters/UserIdParam"
get:
operationId: getUser
summary: Get user by ID
tags:
- Users
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"404":
$ref: "#/components/responses/NotFound"
security:
- bearerAuth: []
patch:
operationIdImplementation Guide
Prerequisites
- ›Claude Desktop or compatible AI client with skill support
- ›Clear understanding of task or problem to solve
- ›Willingness to iterate and refine outputs
Time Estimate
15-45 minutes depending on use case complexity
Steps
- 1Install skill using provided installation command
- 2Test with simple use case relevant to your work
- 3Evaluate output quality and relevance
- 4Iterate on prompts to improve results
- 5Integrate into regular workflow if valuable
Common Pitfalls
- ⚠Expecting perfect results without iteration
- ⚠Not providing enough context in prompts
- ⚠Using skill for tasks outside its intended scope
- ⚠Accepting outputs without review and validation
Best Practices
✓ Do
- +Start with clear, specific prompts
- +Provide relevant context and constraints
- +Review and refine all outputs before using
- +Iterate to improve output quality
- +Document successful prompt patterns
✗ Don't
- −Don't use without understanding skill limitations
- −Don't skip validation of outputs
- −Don't share sensitive information in prompts
- −Don't expect skill to replace human judgment
💡 Pro Tips
- ★Be specific about desired format and style
- ★Ask for multiple options to choose from
- ★Request explanations to understand reasoning
- ★Combine AI efficiency with human expertise
When to Use This
✓ Use when
Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement.
✗ Avoid when
Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion.
Learning Path
- 1Familiarize yourself with skill capabilities and limitations
- 2Start with low-risk, non-critical tasks
- 3Progress to more complex and valuable use cases
- 4Build expertise through regular use and experimentation
Related Skills
python-code-style
9wshobson/agents
Backendsame repoposter-design-generation
28eachlabs/skills
Frontendtag: generationspec-miner
15jeffallan/claude-skills
Productivitytag: specppt-generation
11bytedance/deer-flow
Productivitytag: generationtypescript-best-practices
146jwynia/agent-skills
Backendsame categoryfastapi-python
61mindrally/skills
Backendsame categoryReviews
4.6★★★★★66 reviews- KKiara Jackson★★★★★Dec 28, 2024
openapi-spec-generation reduced setup friction for our internal harness; good balance of opinion and flexibility.
- MMateo Ghosh★★★★★Dec 24, 2024
openapi-spec-generation is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.
- DDhruvi Jain★★★★★Dec 16, 2024
Keeps context tight: openapi-spec-generation is the kind of skill you can hand to a new teammate without a long onboarding doc.
- NNoah Okafor★★★★★Nov 19, 2024
openapi-spec-generation is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.
- SSofia Mehta★★★★★Nov 15, 2024
openapi-spec-generation reduced setup friction for our internal harness; good balance of opinion and flexibility.
- OOshnikdeep★★★★★Nov 7, 2024
Registry listing for openapi-spec-generation matched our evaluation — installs cleanly and behaves as described in the markdown.
- GGanesh Mohane★★★★★Oct 26, 2024
openapi-spec-generation reduced setup friction for our internal harness; good balance of opinion and flexibility.
- VValentina Desai★★★★★Oct 10, 2024
Keeps context tight: openapi-spec-generation is the kind of skill you can hand to a new teammate without a long onboarding doc.
- AAnaya Kim★★★★★Oct 6, 2024
Registry listing for openapi-spec-generation matched our evaluation — installs cleanly and behaves as described in the markdown.
- OOlivia Park★★★★★Sep 25, 2024
Useful defaults in openapi-spec-generation — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.
showing 1-10 of 66
1 / 7Discussion
Comments — not star reviews- No comments yet — start the thread.