@restdocs/jest

Jest integration for @restdocs - automatic documentation generation from tests.

Installation

npm install --save-dev @restdocs/jest

Setup

jest.config.js

module.exports = {
    setupFilesAfterEnv: ['@restdocs/jest'],
    reporters: [
        'default',
        [
            '@restdocs/jest/reporter',
            {
                outputDir: './docs/api',
                formats: ['openapi', 'markdown', 'typescript'],
                openapi: {
                    info: {
                        title: 'My API',
                        version: '1.0.0',
                    },
                },
            },
        ],
    ],
};

Usage

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

describe('Users API', () => {
    it('creates a user', async () => {
        await request(app).post('/api/users').send({ email: '[email protected]' });

        api.document('POST /api/users', {
            description: 'Create a new user',
            request: {
                email: field.email().required(),
            },
            response: {
                id: field.uuid(),
            },
        });
    });
});

Features

• 🎯 Automatic test context tracking
• 📄 Multi-format output generation
• 🔧 Custom Jest reporter
• ✅ Zero configuration after setup

Documentation

See main documentation for full configuration options.

License

MIT