Migration Guides
Getting Started with API Migration
Put Zuplo in front of your existing API by importing its OpenAPI document and forwarding requests to your backend. This tutorial helps you verify the gateway before you change where your clients send traffic.
Bring your OpenAPI document and backend URL, or use the included Petstore example. Choose a workflow to import the API and compare a read-only request through Zuplo with the same request sent directly to your backend.
Choose a workflow to start
Pick one of these three options to open your tutorial. You can switch workflows later in the guide.
Zuplo PortalConfigure your project in the browser with the visual Route Designer and built-in testing tools.What you'll needa browser and a free Zuplo accountUse the PortalLocal with an editorCreate a project with the Zuplo CLI, edit its files, and test changes on your machine.What you'll needNode.js 24+, a terminal, and your editorUse an editorLocal with an AI agentUse a guided prompt with Claude Code, Cursor, or Codex, then review and test the changes.What you'll needNode.js 24+ and an AI coding agentUse an AI agent
What you'll build
About 30 min for the tutorialImport an API into Zuplo and verify that a request through the gateway matches the original backend.
- Import your API or the Petstore example
- Configure a route to your backend
- Compare a read-only request through both endpoints