Prototipo · Versión preliminar: todos los servidores del registro oficial, sincronizados cada 30 minutos. Inicia sesión con Google para escribir reseñas.Prototipo · se actualiza cada 30 min
PopNx MCPServidores MCP para quienes usan IA · en palabras sencillas

Openapi Sync MCP

de akintomiwa-fisayoversión 6.4.2i★ 1iSe ejecuta en tu computadoraRepositorio ↗
Nombre en el registroio.github.akintomiwa-fisayo/openapi-sync-mcp

Cómo instalar

What it does

Type-safe MCP server for OpenAPI Sync to inspect, validate, and synchronize OpenAPI specs.

  • Connects Se ejecuta en tu computadora
  • Account or key No key needed
  • Category Herramientas para desarrolladores

Úsalo junto con

Skills que enseñan a la IA este tipo de trabajo; funcionan junto a este

rea

Reverse engineer anything with agents, from app behavior down to native binaries.

de morluto★ 467.2351 skills

Skill · Guía de trabajo

andrej-karpathy-skills

A single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathy's observations on LLM coding pitfalls.

de multica-ai★ 234.1251 skills

Skill · Guía de trabajoSin licencia indicada

graphify

Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable knowledge graph. A /graphify skill for Claude Code, Cursor, Codex, and Gemini CLI: local deterministic AST parsing, every edge explained, no vector store.

de Graphify-Labs★ 149.8731 skills

Skill · Guía de trabajo

Por qué está en este puesto

Las listas se ordenan por una puntuación de uso (sobre 100) con estas partes

Popularidad23/80Estrellas de GitHub o descargas semanales: la mayor cuenta 60, la menor 20
Actualidad12/12Puntuación completa con una versión o cambio de código en 30 días
Sigue respondiendo0/8El endpoint en la nube respondió en la última revisión
Puntuación de uso35/100

Calidad: Pasó 3/3 revisiones básicas (se muestra, no ordena) · Impulso: 59 (Solo se usa en la pestaña En auge)

Instalación

Elige la app de IA que usas y copia la configuración.

Que tu IA lo instale con una frase

Instala Openapi Sync MCP. Sigue https://mcp.popnx.com/i/akintomiwa-fisayo-openapi-sync-mcp.md, enséñame los comandos y espera mi OK antes de ejecutarlos.

Pégala en una IA que trabaje en tu equipo (como Claude Code o Cursor). Lee nuestros pasos, te muestra los comandos y espera tu OK. Sin clave ni registro. · Ver el texto completo que lee tu IA

Pasó 3/3 revisiones · Funciona en tu computadora · ✓ Comandos revisados el 13 nov 2026

Primero: ¿qué IA usas?

Elige tu app y los pasos aparecen abajo.

Funciona con Claude, pero hay que preparar algo antes

Instala Node.js en tu computadora primero (una sola vez) · Solo en la app de Claude para computadora (Windows o Mac), no en la web ni en el móvil

Que la IA lo instale

Copia este mensaje en un chat de Claude. La IA revisa tu equipo, te dice qué archivo va a cambiar y espera tu visto bueno cada vez.

Instala el MCP server Openapi Sync MCP para Claude en este equipo, en este orden: 1) Comprueba Node.js con node -v. Si falta, dime que lo instale desde https://nodejs.org/en/download; no lo instales tú. 2) Usa solo esta configuración (ya revisada por PopNx MCP): { "mcpServers": { "openapi-sync": { "command": "npx", "args": [ "-y", "openapi-sync-mcp" ] } } } 3) Dime la ruta completa del archivo que vas a cambiar o el comando que vas a ejecutar y espera mi visto bueno. 4) No hace falta clave. 5) Haz lo acordado y comprueba que las herramientas de Openapi Sync MCP aparecen de verdad.

Este mensaje no lleva tu clave. Si hace falta una, la IA te pedirá que la pegues tú en el archivo o en el campo de la app.

  1. Instala Node.js (si no lo tienes)

    ¿Ya está instalado? Compruébalo primero · Abre la Terminal, escribe este comando y pulsa Enter

    node -v
    • Aparece un número de versión, p. ej. v26.13.1 = ya está instalado, sáltate este paso
    • Aparece "command not found" (en Windows, "is not recognized") = aún no está instalado, o acabas de instalarlo y debes cerrar y volver a abrir la Terminal
    Cómo abrir la Terminal

    Mac: pulsa ⌘ + Espacio, escribe Terminal y pulsa Enter

    Windows: abre Inicio, escribe Windows PowerShell y elige Abrir

    Si no está instalado: Abre la página oficial de descargas, elige la versión LTS y el instalador de clics: .pkg en Mac · .msi en Windows. Haz doble clic y sigue hasta el final. No necesitas ningún comando curl

    Abrir la página de descarga de Node.js ↗

    Al terminar, cierra la Terminal, ábrela de nuevo y ejecuta el mismo comando. Debe aparecer un número de versión: node -v

    Se instala una vez y sirve para todo lo que usa Node.js

  2. Abre el archivo de configuración de la app de Claude de escritorio

    SettingsDeveloperEdit Config

  3. Pega esta configuración y guarda el archivo

    {
      "mcpServers": {
        "openapi-sync": {
          "command": "npx",
          "args": [
            "-y",
            "openapi-sync-mcp"
          ]
        }
      }
    }
  4. Cierra Claude y vuelve a abrirlo

  5. Pruébalo

    Usa Openapi Sync MCP y dime qué puedes hacer por mí; luego muéstrame una cosa

    ✓ Si Claude dice que está usando Openapi Sync MCP o muestra una herramienta de Openapi Sync MCP en la respuesta, ya está conectado

Nombres de menú comprobados con la ayuda de Anthropic el 11 nov 2026 · tu pantalla puede variar un poco según la versión

ChatGPT todavía no puede conectar Openapi Sync MCP

Openapi Sync MCP se instala en tu computadora, pero ChatGPT solo conecta servidores que funcionan en la web

Lo que puedes hacer en su lugar

A · Usa una app que pueda conectar Openapi Sync MCP

  • Instala Node.js en tu computadora primero (una sola vez) · Solo en la app de Claude para computadora (Windows o Mac), no en la web ni en el móvil
  • Instala Node.js en tu computadora primero (una sola vez)
  • Instala Node.js en tu computadora primero (una sola vez)
  • Instala Node.js en tu computadora primero (una sola vez)

B · Otros en Herramientas para desarrolladores que funcionan con ChatGPT

Elegidos entre los más usados de la misma categoría, solo los que se conectan con una dirección y sin clave

Funciona con Claude Code, pero hay que preparar algo antes

Instala Node.js en tu computadora primero (una sola vez)

Que la IA lo instale

Copia este mensaje en un chat de Claude Code. La IA revisa tu equipo, te dice qué archivo va a cambiar y espera tu visto bueno cada vez.

Instala el MCP server Openapi Sync MCP para Claude Code en este equipo, en este orden: 1) Comprueba Node.js con node -v. Si falta, dime que lo instale desde https://nodejs.org/en/download; no lo instales tú. 2) Usa solo esta configuración (ya revisada por PopNx MCP): claude mcp add --scope user openapi-sync -- npx -y openapi-sync-mcp 3) Dime la ruta completa del archivo que vas a cambiar o el comando que vas a ejecutar y espera mi visto bueno. 4) No hace falta clave. 5) Haz lo acordado y comprueba que las herramientas de Openapi Sync MCP aparecen de verdad.

Este mensaje no lleva tu clave. Si hace falta una, la IA te pedirá que la pegues tú en el archivo o en el campo de la app.

  1. Instala Node.js (si no lo tienes)

    ¿Ya está instalado? Compruébalo primero · Abre la Terminal, escribe este comando y pulsa Enter

    node -v
    • Aparece un número de versión, p. ej. v26.13.1 = ya está instalado, sáltate este paso
    • Aparece "command not found" (en Windows, "is not recognized") = aún no está instalado, o acabas de instalarlo y debes cerrar y volver a abrir la Terminal
    Cómo abrir la Terminal

    Mac: pulsa ⌘ + Espacio, escribe Terminal y pulsa Enter

    Windows: abre Inicio, escribe Windows PowerShell y elige Abrir

    Si no está instalado: Abre la página oficial de descargas, elige la versión LTS y el instalador de clics: .pkg en Mac · .msi en Windows. Haz doble clic y sigue hasta el final. No necesitas ningún comando curl

    Abrir la página de descarga de Node.js ↗

    Al terminar, cierra la Terminal, ábrela de nuevo y ejecuta el mismo comando. Debe aparecer un número de versión: node -v

    Se instala una vez y sirve para todo lo que usa Node.js

  2. Abre la Terminal

    Mac: pulsa Command+Espacio y escribe Terminal · Windows: abre PowerShell

  3. Pega este comando y pulsa Enter

    claude mcp add --scope user openapi-sync -- npx -y openapi-sync-mcp
  4. Escribe /mcp en Claude Code

    Deberías ver Openapi Sync MCP en la lista como conectado

  5. Pruébalo

    Usa Openapi Sync MCP y dime qué puedes hacer por mí; luego muéstrame una cosa

    ✓ Si Claude Code dice que está usando Openapi Sync MCP o muestra una herramienta de Openapi Sync MCP en la respuesta, ya está conectado

Nombres de menú comprobados con la ayuda de Anthropic el 11 nov 2026 · tu pantalla puede variar un poco según la versión

Funciona con Cursor, pero hay que preparar algo antes

Instala Node.js en tu computadora primero (una sola vez)

Que la IA lo instale

Copia este mensaje en un chat de Cursor. La IA revisa tu equipo, te dice qué archivo va a cambiar y espera tu visto bueno cada vez.

Instala el MCP server Openapi Sync MCP para Cursor en este equipo, en este orden: 1) Comprueba Node.js con node -v. Si falta, dime que lo instale desde https://nodejs.org/en/download; no lo instales tú. 2) Usa solo esta configuración (ya revisada por PopNx MCP): { "mcpServers": { "openapi-sync": { "command": "npx", "args": [ "-y", "openapi-sync-mcp" ] } } } 3) Dime la ruta completa del archivo que vas a cambiar o el comando que vas a ejecutar y espera mi visto bueno. 4) No hace falta clave. 5) Haz lo acordado y comprueba que las herramientas de Openapi Sync MCP aparecen de verdad.

Este mensaje no lleva tu clave. Si hace falta una, la IA te pedirá que la pegues tú en el archivo o en el campo de la app.

  1. Instala Node.js (si no lo tienes)

    ¿Ya está instalado? Compruébalo primero · Abre la Terminal, escribe este comando y pulsa Enter

    node -v
    • Aparece un número de versión, p. ej. v26.13.1 = ya está instalado, sáltate este paso
    • Aparece "command not found" (en Windows, "is not recognized") = aún no está instalado, o acabas de instalarlo y debes cerrar y volver a abrir la Terminal
    Cómo abrir la Terminal

    Mac: pulsa ⌘ + Espacio, escribe Terminal y pulsa Enter

    Windows: abre Inicio, escribe Windows PowerShell y elige Abrir

    Si no está instalado: Abre la página oficial de descargas, elige la versión LTS y el instalador de clics: .pkg en Mac · .msi en Windows. Haz doble clic y sigue hasta el final. No necesitas ningún comando curl

    Abrir la página de descarga de Node.js ↗

    Al terminar, cierra la Terminal, ábrela de nuevo y ejecuta el mismo comando. Debe aparecer un número de versión: node -v

    Se instala una vez y sirve para todo lo que usa Node.js

  2. Pulsa este botón para abrir Cursor

    Abrir en Cursor

    Cursor te pedirá confirmar; pulsa Install

  3. Abre el chat de IA de Cursor en modo Agent

  4. Pruébalo

    Usa Openapi Sync MCP y dime qué puedes hacer por mí; luego muéstrame una cosa

    ✓ Si Cursor dice que está usando Openapi Sync MCP o muestra una herramienta de Openapi Sync MCP en la respuesta, ya está conectado

Nombres de menú comprobados con la ayuda de Cursor el 11 nov 2026 · tu pantalla puede variar un poco según la versión

Funciona con VS Code, pero hay que preparar algo antes

Instala Node.js en tu computadora primero (una sola vez)

Que la IA lo instale

Copia este mensaje en un chat de VS Code. La IA revisa tu equipo, te dice qué archivo va a cambiar y espera tu visto bueno cada vez.

Instala el MCP server Openapi Sync MCP para VS Code en este equipo, en este orden: 1) Comprueba Node.js con node -v. Si falta, dime que lo instale desde https://nodejs.org/en/download; no lo instales tú. 2) Usa solo esta configuración (ya revisada por PopNx MCP): { "servers": { "openapi-sync": { "type": "stdio", "command": "npx", "args": [ "-y", "openapi-sync-mcp" ] } } } 3) Dime la ruta completa del archivo que vas a cambiar o el comando que vas a ejecutar y espera mi visto bueno. 4) No hace falta clave. 5) Haz lo acordado y comprueba que las herramientas de Openapi Sync MCP aparecen de verdad.

Este mensaje no lleva tu clave. Si hace falta una, la IA te pedirá que la pegues tú en el archivo o en el campo de la app.

  1. Instala Node.js (si no lo tienes)

    ¿Ya está instalado? Compruébalo primero · Abre la Terminal, escribe este comando y pulsa Enter

    node -v
    • Aparece un número de versión, p. ej. v26.13.1 = ya está instalado, sáltate este paso
    • Aparece "command not found" (en Windows, "is not recognized") = aún no está instalado, o acabas de instalarlo y debes cerrar y volver a abrir la Terminal
    Cómo abrir la Terminal

    Mac: pulsa ⌘ + Espacio, escribe Terminal y pulsa Enter

    Windows: abre Inicio, escribe Windows PowerShell y elige Abrir

    Si no está instalado: Abre la página oficial de descargas, elige la versión LTS y el instalador de clics: .pkg en Mac · .msi en Windows. Haz doble clic y sigue hasta el final. No necesitas ningún comando curl

    Abrir la página de descarga de Node.js ↗

    Al terminar, cierra la Terminal, ábrela de nuevo y ejecuta el mismo comando. Debe aparecer un número de versión: node -v

    Se instala una vez y sirve para todo lo que usa Node.js

  2. Pulsa este botón para abrir VS Code

    Abrir en VS Code

    VS Code te pedirá confirmar; pulsa Install

  3. Abre el chat de IA de VS Code en modo Agent

  4. Pruébalo

    Usa Openapi Sync MCP y dime qué puedes hacer por mí; luego muéstrame una cosa

    ✓ Si VS Code dice que está usando Openapi Sync MCP o muestra una herramienta de Openapi Sync MCP en la respuesta, ya está conectado

Nombres de menú comprobados con la ayuda de VS Code el 11 nov 2026 · tu pantalla puede variar un poco según la versión

Otras apps que usan MCP, como Windsurf, Zed o Gemini CLI, añaden servidores de forma distinta. Míralo en la lista de apps

Ver todas las apps que usan MCP →

La configuración JSON está en “Para desarrolladores”, abajo

¿Te atascaste? Pregunta a quien usa Openapi Sync MCP💬 Conversación →
Para desarrolladores: comandos de Terminal y configuración JSON

Instalado en tu computadora

Claude Code

claude mcp add --scope user openapi-sync -- npx -y openapi-sync-mcp

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "openapi-sync": {
      "command": "npx",
      "args": [
        "-y",
        "openapi-sync-mcp"
      ]
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "openapi-sync": {
      "command": "npx",
      "args": [
        "-y",
        "openapi-sync-mcp"
      ]
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "openapi-sync": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "openapi-sync-mcp"
      ]
    }
  }
}

Esta configuración se genera a partir de la ficha del creador en el registro. Si el README dice otra cosa, sigue el README.

De un vistazo

Descargas por semanai
888/sem
Conexión
Se ejecuta en tu computadora
Última versióni
6.4.2
Publicado en el registroi
18 sept 2026
Último cambio de códigoi
15 nov 2026
Creador
akintomiwa-fisayo
Paquetes
npm: openapi-sync-mcp
Estado en el registro
Activo

Qué apps pueden usarlo

Según cómo se conecta este servidor y la documentación de cada app, comprobado el 10 nov 2026.

Se ejecutan en tu computadora en

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

Todas las apps, con ventajas y desventajas →

Qué puede hacer

Se ejecuta en tu computadora; la lista de herramientas aparece en tu app de IA después de instalarlo.

Revisiones básicasi

Revisamos información que cualquiera puede ver; no hemos leído el código. Las revisiones que no aplican no se cuentan. · Revisado el 19 nov 2026

  • ✓ Superada

    El creador coincide con el repo

    El nombre en el registro se verificó con la cuenta de GitHub akintomiwa-fisayo, dueña del repo

  • ✓ Superada

    Sigue en mantenimiento

    Último cambio de código: hace 4 días

  • ✓ Superada

    Tiene licencia

    Usa ISC

  • – No aplica

    El endpoint responde

    Este se ejecuta en tu computadora; no hay endpoint en internet

  • – No aplica

    Inicio de sesión con OAuth

    Se ejecuta en tu computadora y usa ajustes locales en su lugar

  • … Aún sin revisar

    Sin instrucciones ocultas en las descripciones de herramientas

    Se ejecuta en tu computadora; solo podemos leer listas de herramientas de endpoints en internet

Vulnerabilidades publicadas (OSV.dev)

Sin entradas en OSV.dev para openapi-sync-mcp@6.4.2

Solo revisa esta versión del paquete, no todas sus dependencias · revisado 15 nov 2026

Qué revisamos → · JSON

Creadores: pedir otra revisión o avisar de un dato erróneo
Para autores: añade una insignia a tu README

Si lo creaste tú, pega este código en tu README. La insignia enlaza a esta página.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/akintomiwa-fisayo-openapi-sync-mcp.svg)](https://mcp.popnx.com/en/servers/akintomiwa-fisayo-openapi-sync-mcp)

Conversación

Pregunta, comparte un consejo o avisa de que no funciona. Ordenado por lo que la gente marcó como útil.

Aún no hay publicaciones. Sé la primera persona en preguntar o compartir.

Lo publicado aquí lo escriben usuarios, no el equipo de PopNx.

Inicia sesión para publicar

Reseñas de usuarios

Aún no hay reseñas

Inicia sesión para escribir una reseña

Comparado con otros en Herramientas para desarrolladoresi

  • Más estrellas que el 69% de los otros 6103 servidores de esta categoría
  • Publicado en el registro más recientemente que el 37% de los otros 6103 servidores de esta categoría
  • Revisiones básicas iguales o mejores que el 99% de los otros 6103 servidores de esta categoría

Comparado con todos los servidores activos de esta categoría en el registro. Las estrellas solo cuentan cuando quien lo publica es dueño del repo.

Preguntas frecuentes

¿Es seguro Openapi Sync MCP?

Superó 3 de 3 revisiones básicas aplicables. No hemos leído el código. Antes de agregar una clave o un token, revisa qué acceso pide el servidor y usa una clave que tenga solo los permisos que necesitas.

¿Qué claves o códigos necesita?

El registro no indica ninguna clave obligatoria, aunque algunos servidores te piden iniciar sesión la primera vez que los usas.

¿Se ejecuta en mi computadora o en la nube?

Se ejecuta en tu computadora. Tu app de IA lo inicia cuando hace falta, y los datos no pasan por los servidores del creador (a menos que el propio servidor llame a un servicio en línea).

¿Sigue en mantenimiento?

El repo de GitHub cambió por última vez hace 4 días, y la última versión (6.4.2) llegó al registro hace 2 meses.

¿Qué apps pueden usarlo?

Las apps compatibles con MCP, como Claude Desktop, Claude Code, Cursor y VS Code. También necesitas Node.js en tu computadora.

¿Qué puedo usar en su lugar?

En la misma categoría: GitDiagram, Appllama, Cloudflare MCP, Omnara, Repowise

Alternativas parecidas

Misma categoría, otros creadores, comandos ya revisados. Primero los oficiales, luego por estrellas.

Cómo leer una tarjeta:↓ Descargas por semanai★ Estrellas de GitHubiTres pilares: reseñas · revisiones · usoiActualizado = fecha en que se publicó la última versión en el registroi

GitDiagram

Architecture diagrams, explanations and Mermaid source for public GitHub repositories.

de ahmedkhaleel2004Muy usado★ 19 milActualizado hace 2 meses

Se ejecuta en la nube✓ del servicio · gitdiagram.comProbado por el equipo de PopNx

Appllama

Study screens, flows and paywalls from top-earning iOS apps, then build from what wins.

de AppllamaMuy usado★ 5,2 milActualizado hace 3 meses

Se ejecuta en la nube✓ del servicio · appllama.io

Cloudflare MCP

Cloudflare MCP servers

de cloudflareMuy usado★ 4,5 milActualizado hace 14 meses

Se ejecuta en la nube✓ del servicio · mcp.cloudflare.comProbado por el equipo de PopNx

Omnara

Deploy durable AI agents with Omnara, an open-source managed-agent platform.

de omnara-aiMuy usado★ 3,4 milActualizado hace 2 meses

Se ejecuta en la nube✓ del servicio · omnara.com

Repowise

Codebase intelligence for AI coding agents: graph, git history, docs, decisions, code health.

de repowise-devMuy usado↓ 6,5 mil/sem★ 8,2 mil Estrellas de todo el repositorioActualizado hace 6 días

Computadora o nube✓ del servicio · repowise.dev
Comparado con otros parecidos
Este
Openapi Sync MCP
GitDiagramAppllamaCloudflare MCPOmnaraRepowise
Dónde se ejecutaSe instala en tu equipoFunciona en la nube, sin instalar nadaFunciona en la nube, sin instalar nadaFunciona en la nube, sin instalar nadaFunciona en la nube, sin instalar nadaEn la nube o instalado en tu equipo
Necesita claveNoNoNoNoNoNo
Se añade con + en ClaudeNoNoNoSíNoNo
Revisiones básicas3/34/44/44/44/45/5
LicenciaISCMITMITApache-2.0Apache-2.0AGPL-3.0
PrecioSin coste en el registroSin coste en el registroSin coste en el registroSin coste en el registroSin coste en el registroSin coste en el registro

README del creador

Abrir el README

Copiado tal cual del repo del creador. PopNx MCP no lo ha revisado ni lo respalda. Se quitaron HTML, imágenes y scripts. Los enlaces llevan fuera de este sitio.

OpenAPI Sync

OpenAPI Sync is a powerful developer tool that automates the synchronization of your API documentation with your codebase using OpenAPI (formerly Swagger) specifications. It generates TypeScript types, fully-typed API clients (Fetch, Next.js Fetch, Axios, React Query, SWR, RTK Query), endpoint definitions, runtime validation schemas (Zod, Yup, Joi), and comprehensive documentation from your OpenAPI schema—ensuring type safety from API specification through client implementation to runtime validation.

📘 [Full documentation available at openapi-sync.com](https://openapi-sync.com)

Core Features

  • ⚡ Zero-Config Presets - 10 pre-configured framework presets (React Query, SWR, Axios, Fetch, RTK Query, Next.js, Python) for instant setup
  • 🔄 Real-time API Synchronization - Automatically syncs OpenAPI specs from remote URLs with configurable intervals
  • 📝 Automatic Type Generation - Generates TypeScript interfaces for all endpoints with full nested support
  • 🔐 Runtime Validation - Generate Zod, Yup, or Joi schemas from OpenAPI specs with all constraints preserved
  • 🎯 Interactive Setup Wizard - Streamlined configuration with auto-enabled tag-based folder splitting
  • 🛡️ Enterprise Ready - Error handling, validation, state persistence, and custom code preservation
  • 📦 Folder Splitting - Organize code by tags or custom logic with aggregator files for easy imports
  • 📚 Rich Documentation - JSDoc comments with cURL examples and inline usage guides
  • 🤖 Agent-Ready Endpoints - Browse endpoints with pagination and path filtering, inspect deep endpoint details, and read generated types without reloading the spec
  • 🩺 Diagnostic Doctor - Diagnostic health checks for config validity, spec accessibility, peer dependencies, cache, and folder write permissions
  • 🧹 Stale File Purge - Manifest-based stale code detection and cleanup with dry-run support to prevent orphaned code
  • 🔄 Custom Code Injection - Preserve your custom code between regenerations with protected sections

View all features →

Installation

npm install openapi-sync

or

npm install -g openapi-sync

or use directly

npx openapi-sync


🤖 Using with AI Agents

All CLI commands and programmatic APIs are agent-safe — no interactive prompts, fully non-blocking. Use --json for machine-readable output and --silent to suppress logs.

Full agent reference: llms.txt — a structured discovery file for LLMs, Copilots, and MCP tools.

Agent Quick-Start (no prompts)
# 1. Create config (all settings as flags — no stdin required)

npx openapi-sync init --no-interactive \ --api-name petstore \ --api-url https://petstore3.swagger.io/api/v3/openapi.json \ --output-folder ./src/api \ --client-type react-query \ --validation-library zod \ --config-format typescript \ --json

Or for protected specs, configure auth directly on init:

npx openapi-sync init --no-interactive \ --api-name backend \ --api-url https://api.example.com/openapi.json \ --auth-type bearer \ --auth-token '${env.SPEC_TOKEN}' \ --preset react-query-zod \ --json

2. Validate config + specs before writing any files

npx openapi-sync validate --json

3. Sync — generate types, endpoints, and schemas

npx openapi-sync --json

4. Generate a typed API client

npx openapi-sync generate-client --type react-query --json

Machine-Readable Output (--json)

Every command emits a single, pure JSON object to stdout when --json is passed, making it safe to pipe directly into jq or consume from automated agents. All human-readable progress logs are suppressed or directed to stderr.

$ npx openapi-sync --json

{ "success": true, "apis": ["petstore"], "filesWritten": ["src/api/petstore/types.ts", "src/api/petstore/endpoints.ts"], "endpointCount": 20, "warnings": [], "errors": [], "phases": { "sync": { "filesWritten": ["src/api/petstore/types.ts", "src/api/petstore/endpoints.ts"], "endpointCount": 20 }, "client": { "filesWritten": [], "endpointCount": 20 } } }

$ npx openapi-sync validate --json

{ "valid": true, "apis": { "petstore": { "valid": true, "endpointCount": 20 } }, "configErrors": [] }

$ npx openapi-sync list-endpoints --json

{ "petstore": [ { "name": "getPetById", "method": "GET", "path": "/pet/{petId}", "tags": ["pet"], "summary": "Find pet by ID" }, { "name": "addPet", "method": "POST", "path": "/pet", "tags": ["pet"], "summary": "Add a new pet" } ] }

$ npx openapi-sync list-endpoints --api petstore --path-contains pet --limit 2 --offset 0 --json
$ npx openapi-sync get-endpoint --api petstore --operation-id getPetById --json
$ npx openapi-sync read-type --api petstore --type-name Pet --json
Dry Run (preview without writing files)

Compact, fast previews of planned files:

npx openapi-sync --dry-run --json

npx openapi-sync generate-client --type fetch --dry-run --json

Layouts & Output Directories
  • Flat Mode (Default): When folderSplit is omitted or empty ({}), files are placed directly in the API folder (endpoints.ts, types/index.ts, types/shared.ts).
  • Tag-Split Mode: Setting folderSplit: { byTags: true } organizes endpoints into tag subfolders (e.g. {tag}/endpoints.ts, {tag}/types.ts, shared.ts).
  • Custom Client Directory: clientGeneration.outputDir (or CLI --output) is fully supported in both flat and folder-split layouts. In flat mode, clients are placed directly in {outputDir}/clients.ts (or api.ts), while in folder-split mode clients are placed in {outputDir}/{tag}/client.ts and aggregated at {outputDir}/clients.ts, with relative imports resolving back to your generated types and endpoints.
Programmatic API (TypeScript)
import {

ValidateConfig, Init, GenerateClient, ListEndpoints, GetEndpointDetails, ReadGeneratedType, Doctor, Purge, } from "openapi-sync";

// Pre-flight check — no files written const validation = await ValidateConfig({ silent: true }); if (!validation.valid) throw new Error(JSON.stringify(validation));

// Diagnostic health check on config, specs, peer dependencies, and directories const health = await Doctor({ silent: true }); console.log("Health check:", health.healthy ? "All checks passed" : "Issues detected");

// Inspect API surface with pagination and filtering const endpoints = await ListEndpoints({ apiName: "petstore", pathContains: "pet", limit: 5, offset: 0, silent: true, }); console.log(endpoints.petstore.length, "endpoints found");

// Inspect a single endpoint in full detail (4-tier fuzzy matching) const detail = await GetEndpointDetails({ apiName: "petstore", operationId: "getPetById", silent: true }); console.log(detail.endpoint.path);

// Read an exact generated type declaration (with optional line pagination) const typeDecl = await ReadGeneratedType({ apiName: "petstore", typeName: "Pet", silent: true }); console.log(typeDecl);

// Sync and get structured result const syncResult = await Init({ silent: true }); if (!syncResult.success) throw new Error(JSON.stringify(syncResult)); console.log("Files written:", syncResult.filesWritten);

// Generate client const clientResult = await GenerateClient({ type: "react-query", silent: true }); console.log(JSON.stringify(clientResult));

// Detect and purge stale files from disk const purgeResult = await Purge({ yes: true, silent: true }); console.log("Purged files:", purgeResult.purged);

Exit Codes
CodeMeaning
0Success
1Config error or validation failed
2Network / spec fetch error
3Generation / file write error
Agent-safe vs Interactive Commands
CommandAgent-safe?Description
npx openapi-sync✅Sync specs, generate types, endpoints, schemas
npx openapi-sync validate✅Validate config + specs; no files written
npx openapi-sync doctor✅Diagnostic health check on config, network, peer deps, cache
npx openapi-sync list-endpoints✅List endpoints with filtering and pagination; no files written
npx openapi-sync get-endpoint✅Inspect detailed schema for one endpoint by operationId or name
npx openapi-sync read-type✅Read generated TypeScript declaration block
npx openapi-sync generate-client✅Generate typed API client (fetch, next-fetch, axios, react-query, swr, rtk-query)
npx openapi-sync purge --yes✅Remove stale generated files without prompting
npx openapi-sync init --no-interactive✅Create config file without prompts
npx openapi-sync init (no flag)❌Interactive wizard (requires stdin)

Quick Start

Option 1: Interactive Setup (Recommended) 🎯

The easiest way to get started is with the interactive setup wizard:

npx openapi-sync init

The wizard will guide you through:

  • 📝 Configuration file format selection (TypeScript, JSON, or JavaScript)
  • 🌐 API specification source (URL or local file)
  • 📁 Folder organization options (split by tags or custom logic)
  • 🚀 Client generation options (React Query, SWR, Fetch, Axios, RTK Query)
  • ✅ Validation library setup (Zod, Yup, Joi)
  • 🔧 Custom code preservation settings
  • 🏷️ Type naming preferences (operationId usage, prefix)
  • 🚫 Endpoint filtering (exclude by tags)
  • 📚 Documentation options (cURL examples)
Option 2: Manual Setup

1. Create `openapi.sync.json` in your project root:

{

"refetchInterval": 5000, "folder": "./src/api", "api": { "petstore": "https://petstore3.swagger.io/api/v3/openapi.json" } }

2. Run the sync command:

npx openapi-sync

3. Use generated types and endpoints:

import { getPetById } from "./src/api/petstore/endpoints";

import { IPet } from "./src/api/petstore/types";

const petUrl = getPetById("123"); // Returns: "/pet/123"

View detailed quick start guide →

⚡ Presets (Zero-Config Framework Setup)

Presets bundle opinionated defaults for your framework, client library, and validation stack into a single name. Instead of configuring dozens of settings by hand, pick a preset during npx openapi-sync init or set "preset": " " in your config file. Any explicit configuration values you define always override preset defaults.

Preset NameTarget Framework / HTTP ClientValidation LibraryFeatures ConfiguredRecommended Dependencies
react-query-zod *(Default/Recommended)*TanStack React Query v5ZodTyped Query & Mutation hooks, Zod schemas, preserved custom code, operationId namingnpm i @tanstack/react-query axios zod
react-query-yupTanStack React Query v5YupTyped Query & Mutation hooks, Yup validation schemas, preserved custom codenpm i @tanstack/react-query axios yup
swr-zodVercel SWRZodSWR hooks with mutation support (useSWRMutation), Zod schemas, preserved custom codenpm i swr axios zod
swr-yupVercel SWRYupSWR hooks with mutation support, Yup schemas, preserved custom codenpm i swr axios yup
axios-zodAxios ClientZodStandalone typed Axios client instance, Zod schemas, preserved custom codenpm i axios zod

| axios-joi | Axios Client | Joi | Standalone typed Axios client, Joi validation schemas (great for

Solo se muestra el principio; lee el resto en el repo