Integreazy

Seamless integration between your frontend and backend, made easy.

Integreazy is your all-in-one integration assistant for hackathons, startups, and rapid prototyping. It automates OpenAPI → TypeScript codegen, provides live API docs, endpoint testing, a mock server, and contract integration checks - all with a beautiful UI.

---

🚀 Features

• Automatic OpenAPI → TypeScript codegen
• Live API documentation and endpoint testing
• Mock server for rapid frontend development
• Integration checker for contract safety
• Modern, professional UI

---

🛠️ Quick Start

1. Clone the Repo

git clone https://github.com/OmkarLolage21/Integreazy.git
cd integration-assistant

2. Start Your Backend

Make sure your backend exposes an OpenAPI/Swagger schema (e.g., http://localhost:8000/openapi.json).

3. One-Command Setup

npm run integreazy

This will:

• Install all dependencies (backend & frontend)
• Generate TypeScript types from your OpenAPI schema
• Start the Integreazy frontend UI

4. Open the App

Go to http://localhost:3000 in your browser.

5. Paste Your Schema URL

Enter your backend's OpenAPI schema URL and click Fetch Schema & Check Integration.

6. Explore & Integrate

• View live docs
• Test endpoints
• Check integration
• Copy generated TypeScript types into your frontend project

7. Iterate

As your backend changes, re-run npm run integreazy to update types and docs.

---

💡 Usage Guide (Step-by-Step)

1. Clone the Repo:

   git clone https://github.com/OmkarLolage21/Integreazy.git

2. Start Your Backend:
   • Make sure your backend exposes an OpenAPI/Swagger schema (e.g., http://localhost:8000/openapi.json).
3. Run Integreazy Setup:

   npm run integreazy

4. Open the App:
   • Go to http://localhost:3000
5. Paste Your Schema URL:
   • Enter your backend's OpenAPI schema URL and click Fetch Schema & Check Integration.
6. Explore & Integrate:
   • View live docs, test endpoints, check integration, and copy generated TypeScript types into your frontend project.
7. Iterate:
   • As your backend changes, re-run npm run integreazy to update types and docs.

Tip: You only need to run Integreazy once per project. Share the generated types with your frontend team for type-safe API integration!

---

🧑‍💻 Example: Type-Safe API Call in React

import axios from "axios";
import type { paths } from "./api-types";

// Type-safe call to GET /items/{item_id}
async function getItem(item_id: number, q?: string) {
  type Params = paths["/items/{item_id}"]["parameters"]["path"];
  type Query = paths["/items/{item_id}"]["parameters"]["query"];
  type Response =
    paths["/items/{item_id}"]["get"]["responses"]["200"]["content"]["application/json"];

  const params: Params = { item_id };
  const query: Query = q ? { q } : {};
  const url = `http://localhost:8000/items/${params.item_id}`;
  const res = await axios.get<Response>(url, { params: query });
  return res.data;
}

---