ASD

Openapi Spec Generation

Genera y mantiene especificaciones OpenAPI 3.1 a partir de código, con enfoque design-first y patrones de validación de contratos de API.

Estrellas
38.8k

en todo el repo

Actividad
47

0–100, la ruta de este skill

Actualizado
hace 2 meses

último commit aquí

Commits
1

últimos 90 días

Contexto
511 tok

49 tok en reposo

Paquete
3 archivos

25 KB

Instalar

Funciona con cualquier agente que lea SKILL.md

npx -y skills add wshobson/agents --skill openapi-spec-generation --agent claude-code

Se instala solo en este repositorio.

Este skill makes network requests.

Qué hace

  • Genera y mantiene especificaciones OpenAPI 3.1 a partir de código existente
  • Aplica un enfoque design-first para escribir contratos de API antes de codificar
  • Valida implementaciones de API contra su especificación
  • Aporta plantillas y ejemplos detallados en references/details.md

Úsalo cuando

  • Crear documentación de API desde cero
  • Generar specs OpenAPI a partir de código existente
  • Diseñar contratos de API con enfoque design-first
  • Generar SDKs de cliente a partir de specs o montar portales de documentación

No lo uses cuando

    Qué lo activa

    Di cualquiera de estas frases y el agente debería cargar este skill.

    • Genera la especificación OpenAPI 3.1 para esta API REST
    • Crea el contrato de API antes de implementar el código
    • Valida que mi implementación cumple con el spec OpenAPI

    SKILL.md

    En inglés

    OpenAPI Spec Generation

    Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.

    When to Use This Skill

    • Creating API documentation from scratch
    • Generating OpenAPI specs from existing code
    • Designing API contracts (design-first approach)
    • Validating API implementations against specs
    • Generating client SDKs from specs
    • Setting up API documentation portals

    Core Concepts

    1. OpenAPI 3.1 Structure

    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: ...
    

    2. Design Approaches

    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

    Templates and detailed worked examples

    Full template library and detailed worked examples live in references/details.md. Read that file when you need the concrete templates.

    Best Practices

    Do's

    • Use $ref - Reuse schemas, parameters, responses
    • Add examples - Real-world values help consumers
    • Document errors - All possible error codes
    • Version your API - In URL or header
    • Use semantic versioning - For spec changes

    Don'ts

    • Don't use generic descriptions - Be specific
    • Don't skip security - Define all schemes
    • Don't forget nullable - Be explicit about null
    • Don't mix styles - Consistent naming throughout
    • Don't hardcode URLs - Use server variables

    Reproducido de wshobson/agents bajo licencia MIT. Leer esta página en markdown.

    Archivos

    3 archivos en el paquete. Solo se lee SKILL.md al activarse — las referencias se cargan si el skill decide que las necesita.

    Detalles

    Creador
    wshobson
    Licencia
    MIT
    Recursos incluidos
    referencias
    Repositorio
    wshobson/agents
    Código fuente
    Ver SKILL.md

    Etiquetas

    Más de wshobson/agents

    Este repo incluye 180 skills. Si instalas uno, normalmente ya tienes los demás.

    Úsalo al seleccionar y colocar iconos, imágenes, SVGs, diagramas o infografías de apoyo aprobados en un PPTX editable.

    Costo de contexto al activarse
    344 tok
    Tamaño del paquete
    2 archivos
    Última actualización
    hace 26 días
    documentos

    Úsalo cuando pidan optimizar un prompt, mejorar su rendimiento, diseñar una plantilla, aplicar chain-of-thought, few-shot prompting o técnicas avanzadas de prompt engineering para producción.

    Costo de contexto al activarse
    1.3k tok
    Tamaño del paquete
    10 archivos
    Última actualización
    el mes pasado
    herramientas desarrollo

    Úsalo al redactar o reparar una especificación JSON con coordenadas explícitas para un PPTX editable.

    Costo de contexto al activarse
    489 tok
    Tamaño del paquete
    2 archivos
    Última actualización
    hace 26 días
    documentos

    Úsalo para validar o reparar un PPTX editable en cuanto a geometría, accesibilidad, editabilidad nativa, linaje de fuente e integridad del paquete OOXML.

    Costo de contexto al activarse
    409 tok
    Tamaño del paquete
    2 archivos
    Última actualización
    hace 26 días
    documentos

    Úsalo para analizar un PPTX de referencia en modo solo lectura: estructura, tema, tipografía, ritmo de layout, diagnósticos, catálogos de plantillas derivados o inspección segura del paquete OOXML.

    Costo de contexto al activarse
    689 tok
    Tamaño del paquete
    8 archivos
    Última actualización
    hace 26 días
    documentos

    Úsalo al preparar la narrativa, las fuentes y el contexto de diseño para un nuevo deck PPTX editable.

    Costo de contexto al activarse
    415 tok
    Tamaño del paquete
    2 archivos
    Última actualización
    hace 26 días
    documentos

    Skills relacionados

    Integra el procesamiento de pagos de PayPal, con soporte para express checkout, suscripciones y gestión de reembolsos en flujos de comercio electrónico.

    Costo de contexto al activarse
    1k tok
    Tamaño del paquete
    2 archivos
    Última actualización
    hace 2 meses
    desarrollo apis

    Construye sistemas RAG (Retrieval-Augmented Generation) para aplicaciones LLM con bases de datos vectoriales y búsqueda semántica, integrando conocimiento externo.

    Costo de contexto al activarse
    1.1k tok
    Tamaño del paquete
    2 archivos
    Última actualización
    el mes pasado
    desarrollo apis

    Construye servicios backend de Node.js listos para producción con Express/Fastify, cubriendo middleware, manejo de errores, autenticación, bases de datos y diseño de APIs.

    Costo de contexto al activarse
    499 tok
    Tamaño del paquete
    3 archivos
    Última actualización
    hace 2 meses
    desarrollo apis