API Documentation

How boringdocs validates API documentation — endpoints, parameters, schemas, and examples.

Endpoint Validation

boringdocs checks that every API endpoint has:

• A description of what it does
• Documented parameters (path, query, body, header)
• Response schema for each status code
• At least one example request/response

Parameter Validation

For each parameter, boringdocs checks:

• Name matches between code and docs
• Type matches (string, number, boolean, etc.)
• Required/optional status matches
• Default values are documented
• Constraints (min, max, pattern) are documented

Response Schema Validation

boringdocs compares the documented response schema against the actual return type:

• Field names match
• Field types match
• Required fields are marked
• Nested objects are fully documented

Example Validation

Code examples in API docs are validated for:

• Syntactic correctness (compiles/parses)
• Parameter names match the endpoint
• Response shape matches the schema

Framework Support

Framework	Endpoint Detection	Type Extraction
Express.js	Route decorators	JSDoc / TypeScript
Fastify	Route definitions	TypeScript
FastAPI	Decorators	Python type hints
Spring Boot	Annotations	Java types
NestJS	Decorators	TypeScript