Skip to content
Skills Library
Programming · Building & coding

openapi-swagger-specification

/openapi-swagger-specification

Use this skill when authoring, validating, and generating mock servers or client SDKs from OpenAPI 3.1 definitions.

Licence
MIT
Last repository change
28.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 28.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Use this skill when authoring, validating, and generating mock servers or client SDKs from OpenAPI 3.1 definitions.

Original author description

Use this skill when authoring, validating, and generating mock servers or client SDKs from OpenAPI 3.1 definitions.

How it works

  1. When to use
  2. Prerequisites
  3. Step-by-step workflow
  4. Commands / code examples
  5. Common mistakes & pitfalls
  6. Verification checklist
  7. Related skills
Original SKILL.md headings · 64 lines, 323 words
SKILL.md preview
---
name: openapi-swagger-specification
description: Use this skill when authoring, validating, and generating mock servers or client SDKs from OpenAPI 3.1 definitions.
---
# OpenAPI & Swagger Specification

## When to use
Use this skill when you need to authoring, validating, and generating mock servers or client SDKs from OpenAPI 3.1 definitions.

## Prerequisites
- Working knowledge of backend architecture, HTTP protocols, and systems programming.
- Appropriate runtime installed (Node.js, Python, Go, Rust, Java, or .NET depending on stack).

## Step-by-step workflow
1. **Define resource contracts**: Establish unambiguous request and response schemas, validation rules, and error envelopes.
2. **Implement routing & handlers**: Structure modular controllers or handlers keeping transport logic isolated from domain services.
3. **Enforce input validation**: Validate and sanitize all inbound parameters, headers, and payloads before reaching business logic.
4. **Implement robust error handling**: Return standardized error responses with consistent HTTP status codes and correlation IDs.
5. **Optimize resilience & telemetry**: Instrument endpoints with structured logging, health checks, metrics, and timeout boundaries.

## Commands / code examples
```ts
// Example implementation pattern for openapi-swagger-specification
import { Request, Response, NextFunction } from 'express';

export interface StandardApiResponse<T> {
  success: boolean;
  data?: T;
  error?: {
    code: string;
    message: string;
    details?: unknown;
  };
  meta?: {
    timestamp: string;
    requestId: string;
  };
}

export function apiResponseHandler<T>(data: T, req: Request): StandardApiResponse<T> {
  return {
    success: true,
    data,
    meta: {
      timestamp: new Date().toISOString(),
      requestId: (req.headers['x-request-id'] as string) || 'req_auto_gen',
    },
  };
}
```

## Common mistakes & pitfalls
- Exposing raw database exceptions or internal stack traces directly in client responses.
- Neglecting request timeouts, allowing hung external dependencies to exhaust server connection pools.
- Omitting correlation IDs (`X-Request-ID`), making distributed debugging impossible across microservices.

## Verification checklist
- [ ] Endpoints adhere strictly to standardized HTTP status codes and contract specifications.
- [ ] Inbound requests are validated against strict type schemas before processing.
- [ ] Errors return structured envelopes without leaking sensitive infrastructure details.
- [ ] All database queries and external service calls have explicit timeout deadlines.

## Related skills
- restful-api-design-best-practices
- api-rate-limiting-throttling
- distributed-tracing-opentelemetry-sdk
- secure-code-review-static-analysis-sast

Versions

The database has no other skills named openapi-swagger-specification.

Database snapshot: 13.11.2026 · package version ba67ec4583b7 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 95openapi-specification-v2
    OpenAPI (Swagger) 2.0 specification for describing REST APIs. Use when writing, validating, or interpreting Swagger 2.0 specs, generating clients/docs, or working with path/operation/parameter/response/schema/security definitions.
  • 90dev-loop-api-client-generator
    Use when the user asks about generating API clients, OpenAPI/Swagger code generation, REST API client SDKs, or automating API client creation. Do NOT use for: writing API servers, or manual HTTP request code.
  • 100openapi-expert
    Expert-level OpenAPI/Swagger specification for API design, documentation, and code generation. Use when the user mentions swagger, API specs, REST, API design, or documentation, or when the task involves OpenAPI Specification, Webhooks, or Polymorphism.
  • 95api-documentation-generator
    Generate OpenAPI/Swagger specifications and API documentation from code or design. Use when creating API docs, generating OpenAPI specs, or documenting REST APIs.
  • 100openapi-codegen
    OpenAPI client code generation. Covers openapi-typescript, openapi-generator-cli, swagger-typescript-api, and trpc-openapi. Use for generating type-safe API clients. USE WHEN: user mentions "OpenAPI codegen", "generate API client", "openapi-typescript", "swagger-typescript-api",…
  • 100openapi
    OpenAPI/Swagger specification. Covers schema definition, paths, and documentation. Use for API documentation. USE WHEN: user mentions "OpenAPI", "Swagger", "API spec", "API documentation", "schema definition", "OpenAPI 3.0", "Swagger UI", asks about "how to write OpenAPI spec",…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.