Jest integration for @restdocs
npm install @restdocs/jestJest integration for @restdocs - automatic documentation generation from tests.
``bash`
npm install --save-dev @restdocs/jest
`javascript`
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',
},
},
},
],
],
};
`typescript
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: 'test@example.com' });
api.document('POST /api/users', {
description: 'Create a new user',
request: {
email: field.email().required(),
},
response: {
id: field.uuid(),
},
});
});
});
``
- 🎯 Automatic test context tracking
- 📄 Multi-format output generation
- 🔧 Custom Jest reporter
- ✅ Zero configuration after setup
See main documentation for full configuration options.
MIT