What it does
Type-safe MCP server for OpenAPI Sync to inspect, validate, and synchronize OpenAPI specs.
- Connects 在你的电脑上运行
- Account or key No key needed
- Category 开发者工具
可搭配使用
教 AI 做这类工作的 Skill,可与本项一起使用
andrej-karpathy-skills
A single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathy's observations on LLM coding pitfalls.
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.
为什么排在这里
列表按使用分(满分 100)排序,由以下部分组成
| 热度 | 23/80 | GitHub 星标或每周下载量:较大的计 60,较小的计 20 |
|---|---|---|
| 新鲜度 | 12/12 | 30 天内有发布或代码更新得满分 |
| 仍在响应 | 0/8 | 上次检查时云端端点有响应 |
| 使用分 | 35/100 |
质量: 基础检查通过 3/3 项(仅展示,不用于排序) · 上升势头: 59 (只用于“上升中”标签)
安装
选择你使用的 AI 应用,然后复制设置。
用一句话让 AI 帮你安装
请帮我安装 Openapi Sync MCP。按照 https://mcp.popnx.com/i/akintomiwa-fisayo-openapi-sync-mcp.md 操作,先把命令给我看,等我同意后再运行。粘贴到能在你电脑上工作的 AI(如 Claude Code、Cursor)。它会读取我们的步骤,先给你看命令,等你同意。无需密钥,无需注册。 · 查看 AI 会读取的全文
通过 3/3 项检查 · 在你的电脑上运行 · ✓ 命令已检查 2026年11月13日
第一步:你用哪个 AI?
选择你用的应用,步骤会显示在下方。
可连接 Claude,但需要先准备
需要先在电脑上安装 Node.js(只需一次) · 仅限电脑上的 Claude 应用(Windows 或 Mac),网页和手机不可用
让 AI 帮你安装
把这段话复制到 Claude 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude 安装 MCP server Openapi Sync MCP,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "mcpServers": { "openapi-sync": { "command": "npx", "args": [ "-y", "openapi-sync-mcp" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 Openapi Sync MCP 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 Node.js(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -v- 显示版本号(例如 v26.13.1)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
node -v安装一次,所有需要 Node.js 的工具都能用
打开电脑版 Claude 应用的设置文件
SettingsDeveloperEdit Config
粘贴这些设置并保存文件
{ "mcpServers": { "openapi-sync": { "command": "npx", "args": [ "-y", "openapi-sync-mcp" ] } } }退出 Claude 再重新打开
试一试
用 Openapi Sync MCP 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude 说正在使用 Openapi Sync MCP,或回答中出现 Openapi Sync MCP 的工具名称,就表示连接成功
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
ChatGPT 暂时无法连接 Openapi Sync MCP
Openapi Sync MCP 需要安装在你的电脑上,而 ChatGPT 只能连接在网上运行的服务器
你可以改用这些方式
A · 使用能连接 Openapi Sync MCP 的应用
- 需要先在电脑上安装 Node.js(只需一次) · 仅限电脑上的 Claude 应用(Windows 或 Mac),网页和手机不可用
- 需要先在电脑上安装 Node.js(只需一次)
- 需要先在电脑上安装 Node.js(只需一次)
- 需要先在电脑上安装 Node.js(只需一次)
B · 开发者工具 类中能连接 ChatGPT 的其他服务器
从同类中使用较多的里挑选,仅限用地址即可连接、无需密钥的
- Sentry✓ ChatGPT
- Compiler Explorer✓ ChatGPT
- GitDiagram✓ ChatGPT
可连接 Claude Code,但需要先准备
需要先在电脑上安装 Node.js(只需一次)
让 AI 帮你安装
把这段话复制到 Claude Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude Code 安装 MCP server Openapi Sync MCP,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):claude mcp add --scope user openapi-sync -- npx -y openapi-sync-mcp 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 Openapi Sync MCP 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 Node.js(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -v- 显示版本号(例如 v26.13.1)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
node -v安装一次,所有需要 Node.js 的工具都能用
打开终端
Mac:按 Command+空格,输入 Terminal · Windows:打开 PowerShell
粘贴这条命令并按 Enter
claude mcp add --scope user openapi-sync -- npx -y openapi-sync-mcp在 Claude Code 中输入 /mcp
应能看到 Openapi Sync MCP 在列表中并显示已连接
试一试
用 Openapi Sync MCP 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude Code 说正在使用 Openapi Sync MCP,或回答中出现 Openapi Sync MCP 的工具名称,就表示连接成功
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
可连接 Cursor,但需要先准备
需要先在电脑上安装 Node.js(只需一次)
让 AI 帮你安装
把这段话复制到 Cursor 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Cursor 安装 MCP server Openapi Sync MCP,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "mcpServers": { "openapi-sync": { "command": "npx", "args": [ "-y", "openapi-sync-mcp" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 Openapi Sync MCP 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 Node.js(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -v- 显示版本号(例如 v26.13.1)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
node -v安装一次,所有需要 Node.js 的工具都能用
在 Cursor 中以 Agent 模式打开 AI 聊天
试一试
用 Openapi Sync MCP 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Cursor 说正在使用 Openapi Sync MCP,或回答中出现 Openapi Sync MCP 的工具名称,就表示连接成功
菜单名称已于 2026年11月11日 对照 Cursor 帮助页面核实 · 你的界面可能因版本略有不同
可连接 VS Code,但需要先准备
需要先在电脑上安装 Node.js(只需一次)
让 AI 帮你安装
把这段话复制到 VS Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 VS Code 安装 MCP server Openapi Sync MCP,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "servers": { "openapi-sync": { "type": "stdio", "command": "npx", "args": [ "-y", "openapi-sync-mcp" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 Openapi Sync MCP 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 Node.js(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -v- 显示版本号(例如 v26.13.1)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
node -v安装一次,所有需要 Node.js 的工具都能用
在 VS Code 中以 Agent 模式打开 AI 聊天
试一试
用 Openapi Sync MCP 告诉我你能帮我做什么,然后做一件给我看✓ 如果 VS Code 说正在使用 Openapi Sync MCP,或回答中出现 Openapi Sync MCP 的工具名称,就表示连接成功
菜单名称已于 2026年11月11日 对照 VS Code 帮助页面核实 · 你的界面可能因版本略有不同
开发者专用:终端命令和 JSON 设置
安装在电脑上
Claude Code
claude mcp add --scope user openapi-sync -- npx -y openapi-sync-mcpClaude 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"
]
}
}
}这些设置是根据作者在注册中心的条目生成的。如果 README 的写法不同,请以 README 为准。
一览
哪些应用可以使用它
依据这个服务器的连接方式和各应用自己的文档,检查于 2026年11月10日。
在你的电脑上运行,适用于
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
它能做什么
它在你的电脑上运行;安装后,工具列表会显示在你的 AI 应用中。
基础检查i
我们检查的是任何人都能看到的信息;我们没有阅读代码。不适用的检查项不计入总数。 · 检查于 2026年11月19日
- ✓ 通过
作者与仓库一致
注册名称已通过 GitHub 账户 akintomiwa-fisayo 验证,该账户拥有此仓库
- ✓ 通过
仍在维护
代码最后更新于4天前
- ✓ 通过
有许可证
使用 ISC
- – 不适用
端点有响应
它在你的电脑上运行,没有互联网端点
- – 不适用
使用 OAuth 登录
在你的电脑上运行,改用本地设置
- … 尚未检查
工具描述中没有隐藏指令
它在你的电脑上运行;我们只能读取互联网端点的工具列表
已公开的漏洞(OSV.dev)
OSV.dev 中没有 openapi-sync-mcp@6.4.2 的记录
只检查这个版本的包本身,不包括所有依赖 · 检查于 2026年11月15日
作者:申请重新检查或报告信息错误
给作者:在 README 中加徽章
如果你是作者,可把这段代码贴到 README。徽章会链接回本页。
[](https://mcp.popnx.com/en/servers/akintomiwa-fisayo-openapi-sync-mcp)讨论
提问、分享技巧或报告无法使用。按“有帮助”数量排序。
用户评价
还没有评价
与“开发者工具”中的其他服务器比较i
- 星标数多于此分类中其他 6116 个服务器的 69%
- 发布到注册中心的时间比此分类中其他 6116 个服务器的 36% 更新
- 基础检查结果等于或优于此分类中其他 6116 个服务器的 99%
与注册中心里这个分类中所有活跃的服务器比较。只有当发布者拥有该仓库时,星标数才计入。
常见问题
Openapi Sync MCP 安全吗?
它在 3 项适用的基础检查中通过了 3 项。我们没有阅读代码。在添加密钥或令牌之前,请先看看这个服务器要求哪些权限,并使用只具备所需权限的密钥。
它需要哪些密钥或代码?
注册中心没有列出必需的密钥,不过有些服务器会在首次使用时要求你登录。
它在我的电脑上运行还是在云端?
它在你的电脑上运行。你的 AI 应用会在需要时启动它,数据不会经过作者的服务器(除非它自己调用在线服务)。
它还在维护吗?
GitHub 仓库最后更新于4天前,最新版本(6.4.2)于2个月前进入注册中心。
哪些应用可以使用它?
支持 MCP 的应用,例如 Claude Desktop、Claude Code、Cursor 和 VS Code。你的电脑上还需要有 Node.js。
有什么可以替代它?
同一分类中有:GitDiagram, Appllama, Cloudflare MCP, Omnara, Repowise
功能相近的其他选择
同一分类、其他作者、命令已通过检查。官方的排在前面,再按星标排序。
如何看卡片:↓ 每周下载量i★ GitHub 星标i三大支柱:评价 · 检查 · 使用情况i更新 = 最新版本发布到注册中心的时间i
GitDiagram
Architecture diagrams, explanations and Mermaid source for public GitHub repositories.
Appllama
Study screens, flows and paywalls from top-earning iOS apps, then build from what wins.
Omnara
Deploy durable AI agents with Omnara, an open-source managed-agent platform.
Repowise
Codebase intelligence for AI coding agents: graph, git history, docs, decisions, code health.
| 本项 Openapi Sync MCP | GitDiagram | Appllama | Cloudflare MCP | Omnara | Repowise | |
|---|---|---|---|---|---|---|
| 运行位置 | 需要安装在电脑上 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 | 云端或安装在电脑上都可以 |
| 需要密钥 | 否 | 否 | 否 | 否 | 否 | 否 |
| 可在 Claude 中按 + 添加 | 否 | 否 | 否 | 是 | 否 | 否 |
| 基础检查 | 3/3 | 4/4 | 4/4 | 4/4 | 4/4 | 5/5 |
| 许可证 | ISC | MIT | MIT | Apache-2.0 | Apache-2.0 | AGPL-3.0 |
| 价格 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 |
作者的 README
打开 README
按原文从作者的仓库复制。PopNx MCP 没有审查或背书其内容。HTML、图片和脚本已被移除。链接会离开本站。
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
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
folderSplitis 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(orapi.ts), while in folder-split mode clients are placed in{outputDir}/{tag}/client.tsand 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
| Code | Meaning |
|---|---|
0 | Success |
1 | Config error or validation failed |
2 | Network / spec fetch error |
3 | Generation / file write error |
Agent-safe vs Interactive Commands
| Command | Agent-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 Name | Target Framework / HTTP Client | Validation Library | Features Configured | Recommended Dependencies |
|---|---|---|---|---|
react-query-zod *(Default/Recommended)* | TanStack React Query v5 | Zod | Typed Query & Mutation hooks, Zod schemas, preserved custom code, operationId naming | npm i @tanstack/react-query axios zod |
react-query-yup | TanStack React Query v5 | Yup | Typed Query & Mutation hooks, Yup validation schemas, preserved custom code | npm i @tanstack/react-query axios yup |
swr-zod | Vercel SWR | Zod | SWR hooks with mutation support (useSWRMutation), Zod schemas, preserved custom code | npm i swr axios zod |
swr-yup | Vercel SWR | Yup | SWR hooks with mutation support, Yup schemas, preserved custom code | npm i swr axios yup |
axios-zod | Axios Client | Zod | Standalone typed Axios client instance, Zod schemas, preserved custom code | npm i axios zod |
| axios-joi | Axios Client | Joi | Standalone typed Axios client, Joi validation schemas (great for