@restdocs/core

Core DSL engine for @restdocs - fluent API documentation from tests.

Installation

npm install @restdocs/core

Quick Start

import { api, field } from '@restdocs/core';

api.document('POST /api/users', {
    description: 'Create a new user',
    tags: ['Users'],
    request: {
        email: field.email().required(),
        name: field.string().required(),
    },
    response: {
        id: field.uuid(),
        email: field.email(),
        name: field.string(),
    },
    statusCode: 201,
});

Features

• 🔧 Fluent DSL API with type safety
• 📝 Schema validation and inference
• 🎯 Zero runtime dependencies
• 📦 Dual package (CJS + ESM)
• ✅ TypeScript first

Documentation

See main documentation for full API reference.

License

MIT