Quick Start

Go to your dashboard and click New Project. Give it a name and choose your stack — Next.js, React Native, Express, or Angular. Your stack controls which code outputs are generated.

You have three options:

• Paste an OpenAPI spec — if you already have a swagger.json or openapi.yaml, paste it directly. Free on all plans.
• Paste a Postman collection — export your collection as JSON and paste it. Invokix converts it automatically.
• Describe in plain English — type what your API does and Invokix generates a complete OpenAPI 3.0 spec in seconds using AI.

Orders API — users can create orders, view history, cancel pending orders.
Each order has line items, total price, and status.
JWT auth. Razorpay for payments.

Once your contract is imported, click Generate. Invokix produces all outputs instantly based on your stack:

• TypeScript types — always
• React Query v5 hooks — Next.js and React stacks
• Zod validation schemas — all stacks
• React Native hooks — React Native stack

export type Order = {
id: string
price: number
status: "pending" | "shipped" | "delivered" | "cancelled"
userId: string
createdAt: string
lineItems: LineItem[]
}

export type LineItem = {
id: string
productId: string
quantity: number
price: number
}

Click Publish to create the first version of your contract. Publishing does three things:

• Creates a version snapshot you can roll back to at any time
• Starts the live mock server automatically
• Sends Slack and email alerts to your team if configured

Before publishing, Invokix checks for breaking changes. If any field renames, type changes, or removals are detected — you see exactly which teams will be affected and can cancel or force publish.

Copy the mock URL from the Mock tab and share it with your frontend and mobile engineers. They can start building immediately — no backend needed.

// During development — points to Invokix mock server
const BASE_URL = "https://invokix.com/mock/your-project-id"

const orders = await fetch(`${BASE_URL}/orders`)
// → [{ id: "uuid", price: 49.99, status: "pending", ... }]

// When your backend is ready — swap one line
const BASE_URL = "https://api.yourcompany.com"

Invite teammates from Settings → Team. They receive an email invite and can access the project as an editor or viewer.