Module: SpecForge::Documentation

Defined in:

lib/spec_forge/documentation.rb,
lib/spec_forge/documentation/builder.rb,
lib/spec_forge/documentation/openapi.rb,
lib/spec_forge/documentation/document.rb,
lib/spec_forge/documentation/generator.rb,
lib/spec_forge/documentation/openapi/v3_0.rb,
lib/spec_forge/documentation/builder/cache.rb,
lib/spec_forge/documentation/builder/compiler.rb,
lib/spec_forge/documentation/openapi/v3_0/tag.rb,
lib/spec_forge/documentation/builder/extractor.rb,
lib/spec_forge/documentation/document/response.rb,
lib/spec_forge/documentation/document/operation.rb,
lib/spec_forge/documentation/document/parameter.rb,
lib/spec_forge/documentation/openapi/v3_0/schema.rb,
lib/spec_forge/documentation/openapi/v3_0/example.rb,
lib/spec_forge/documentation/document/request_body.rb,
lib/spec_forge/documentation/openapi/v3_0/response.rb,
lib/spec_forge/documentation/document/response_body.rb,
lib/spec_forge/documentation/openapi/v3_0/operation.rb,
lib/spec_forge/documentation/openapi/v3_0/media_type.rb,
lib/spec_forge/documentation/openapi/v3_0/error_formatter.rb

Overview

API documentation generation functionality

This module provides tools for extracting API documentation from SpecForge test files and generating various output formats like OpenAPI specifications. It handles the complete pipeline from test execution to documentation rendering.

Examples:

Generating OpenAPI documentation

# From CLI
spec_forge docs generate

# Programmatically
document = Documentation::Loader.load_document
spec = Documentation::OpenAPI["3.0"].new(document).generate

Defined Under Namespace

Modules: OpenAPI Classes: Builder, Document, Generator