@rabstack/rab-api-spec

Type-safe API endpoint specification helpers for TypeScript.

Installation

npm install @rabstack/rab-api-spec

Usage

import { GetApi, PostApi, PutApi, PatchApi, DeleteApi } from '@rabstack/rab-api-spec';

// Define your types
interface User {
  id: string;
  name: string;
  email: string;
}

interface CreateUserBody {
  name: string;
  email: string;
}

// Define endpoints with full type safety
const endpoints = {
  getUsers: GetApi<User[]>('/users'),
  getUser: GetApi<User, unknown, { id: string }>('/users/:id'),
  createUser: PostApi<User, CreateUserBody>('/users'),
  updateUser: PutApi<User, Partial<CreateUserBody>, { id: string }>('/users/:id'),
  deleteUser: DeleteApi<void, { id: string }>('/users/:id'),
};

API

EndpointSpec<RESPONSE, BODY, QUERY, PARAMS>

Core interface with properties:

• url: string - Endpoint URL path
• method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' - HTTP method

Helper Functions

• GetApi<RESPONSE, QUERY, PARAMS>(url) - GET endpoint
• PostApi<RESPONSE, BODY, PARAMS>(url) - POST endpoint
• PutApi<RESPONSE, BODY, PARAMS>(url) - PUT endpoint
• PatchApi<RESPONSE, BODY, PARAMS>(url) - PATCH endpoint
• DeleteApi<RESPONSE, PARAMS>(url) - DELETE endpoint

License

MIT