⚡ SchemaApi

The Contract-First API Standard for TypeScript

Build type-safe APIs at the speed of thought.
Define your contract once. Generate Backend Controllers, Frontend SDKs, and Documentation instantly.

🔮 The Future of API Development

SchemaApi isn't just a validation library. It's an Architecture.

By defining a Single Source of Truth (Contract), you eliminate the disconnect between your Backend and Frontend.

🆚 The Old Way vs. The SchemaApi Way

| ❌ Traditional | ✅ SchemaApi | | :--- | :--- | | Write Controllers manually | Auto-generated strict controllers | | Write types.ts manually | Types inferred from schema | | Write Frontend Fetch calls | Auto-generated Typed SDK | | Update Swagger manually | Auto-generated Documentation | | "It works on my machine" | "It adheres to the contract" |

✨ Superpowers

| 🛡️ End-to-End Type Safety | ⚡ Runtime Validation | 🔌 Adapter Agnostic | | :--- | :--- | :--- | | Your Backend types ARE your Frontend types. Zero duplication. | Powered by Zod. If the data is wrong, the request never hits your logic. | Works with Express, Next.js, Fastify, NestJS, Remix, and more. |

| 📦 Zero-Config SDK | 🚀 Instant Mocking | 📚 Live Documentation | | :--- | :--- | :--- | | Frontend devs get a fully typed client. client.users.get({ id }) | Start frontend work before the backend is even written. | Beautiful HTML docs generated from your contracts. |

🚀 Quick Start

Go from Zero to Production-Ready API in 30 seconds.

1. Initialize

npx @codexsploitx/schemaapi init express

2. Generate Resource

npx @codexsploitx/schemaapi generate resource users

3. Generate SDK

npx @codexsploitx/schemaapi generate sdk users

That's it. You now have:

• contracts/usersContract.ts: The definition.
• src/routes/users.ts: The backend implementation.
• src/sdk/usersClient.ts: The frontend client.

🧩 The Ecosystem (Adapters)

SchemaApi plays nice with everyone. Use the CLI to drop into any stack.

| Stack | Status | CLI Command | | :--- | :---: | :--- | | Express | 🟢 Stable | npx ... init express | | Next.js | 🟢 Stable | npx ... init next | | Fastify | 🟢 Stable | npx ... init fastify | | Remix | 🟢 Stable | npx ... init remix | | NestJS | 🟢 Stable | npx ... init nest | | Deno | 🟢 Stable | npx ... init deno | | Koa/Hapi| 🟡 Beta | npx ... init koa |

🛠️ Usage Example

1️⃣ The Contract (contracts/post.ts)

This is the Law.

import { createContract } from "@codexsploitx/schemaapi";
import { z } from "zod";

export const postContract = createContract({
  name: "posts",
  routes: {
    "GET /posts/:id": {
      params: z.object({ id: z.string().uuid() }),
      responses: {
        200: z.object({ id: z.string(), title: z.string() }),
        404: z.object({ error: z.string() })
      }
    }
  }
});

2️⃣ The Backend (src/routes/post.ts)

Implement the logic. Types are enforced.

// Express Adapter Example
router.get("/posts/:id", async (req, res) => {
  // `req.params.id` is strictly typed as string (UUID)
  const post = await db.find(req.params.id);
  
  if (!post) return res.status(404).json({ error: "Not found" });
  
  // Return type is checked against contract
  return res.json(post); 
});

3️⃣ The Frontend (src/app.ts)

Consume with the generated SDK.

import { PostClient } from "./sdk/postClient";

const client = new PostClient("https://api.myapp.com");

// ✨ Autocomplete heaven
const post = await client.getPost({ id: "123-abc" });
console.log(post.title);

💻 CLI Commands

Your swiss-army knife for API development.

• npx @codexsploitx/schemaapi init <stack> -> Setup project
• npx @codexsploitx/schemaapi generate resource <name> -> Create API route
• npx @codexsploitx/schemaapi generate sdk <name> -> Create Typed Client
• npx @codexsploitx/schemaapi generate tests <name> -> Create Integration Tests
• npx @codexsploitx/schemaapi generate docs -> Build HTML Documentation website
• npx @codexsploitx/schemaapi audit -> Check for security & best practices

Ready to build the future?

Get Started

MIT © CodexSploitx