zipmark/rspec_api_documentation
Rspec Api Documentation
This project is an automated documentation generator that synchronizes API reference materials with actual code behavior. By capturing live HTTP request and response data during the execution of existing test suites, it ensures that documentation remains accurate and consistent with the underlying application.
The tool distinguishes itself by integrating directly into the test runner lifecycle, allowing developers to define API specifications and metadata within their test blocks. This approach enables a test-driven documentation workflow where API behavior is recorded and mapped to structured documentation fields automatically.
The framework supports a broad range of output options, including the generation of standardized OpenAPI schemas, Markdown, and HTML files. It provides granular control over the final output through content filtering and resource organization, allowing for the selective inclusion of endpoints and the logical grouping of API examples.
Features
- API Documentation Tools - Provides a utility that captures live HTTP request and response data during test execution to ensure documentation remains synchronized with code.
- Live API Documentation Generators - Triggers live HTTP requests during test execution to record real-world request and response data for documentation.
- API Documentation Generators - Automatically generates API documentation by scanning and processing existing test suites to ensure accuracy and consistency.
- Automated API Documentation - Generates accurate and up-to-date API reference materials by extracting request and response data directly from existing test suites.
- Test-Driven Documentation Generators - Extracts API specifications and request examples from existing test suites to produce documentation in formats like OpenAPI and Markdown.
- Attribute-to-Specification Mapping - Uses a domain-specific language within test blocks to map test parameters and metadata to structured API documentation fields.
- Request Interception Middleware - Captures live HTTP traffic by injecting a recording layer into the application stack during the execution of automated test cases.
- Test Lifecycle Hooks - Hooks into the test runner lifecycle to intercept and record request and response data during the execution of existing test suites.
- Test-Driven Development Workflows - Maintains documentation as a natural part of the development process by capturing API behavior during the execution of automated tests.
- API Schema Exports - Converts captured API specifications into standard formats like JSON, HTML, and OpenAPI for sharing across different platforms.
- Request Body Documentation - Allows developers to define HTTP headers, query parameters, and request bodies directly within test blocks to document expected API behavior.
- OpenAPI Specification Generators - Converts application test cases into standardized OpenAPI schemas to ensure compatibility with external API design and testing tools.
