Core DSL engine for REST API documentation from tests
npm install @restdocs/coreCore DSL engine for @restdocs - fluent API documentation from tests.
``bash`
npm install @restdocs/core
`typescript
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,
});
``
- 🔧 Fluent DSL API with type safety
- 📝 Schema validation and inference
- 🎯 Zero runtime dependencies
- 📦 Dual package (CJS + ESM)
- ✅ TypeScript first
See main documentation for full API reference.
MIT