API Documentation Toolkit

A collection of Python tools for generating, maintaining, and publishing API documentation. Includes an OpenAPI spec generator that extracts route metadata from annotated Python handlers, a changelog

Product Content

Browse the actual product documentation and code examples included in this toolkit.

Key features of API Documentation Toolkit

Code

• **Changelog Generator** -- Diff two OpenAPI YAML specs (v1 vs v2) and emit a structured markdown changelog listing added endpoints, removed endpoints, modified schemas, and breaking changes.
• **Redoc Theme** -- A custom CSS theme for Redoc-based API documentation portals.
• **Changelog Template** -- A markdown template for API changelog entries with sections for added, changed, deprecated, removed, fixed, and security updates.

**Changelog Generator** -- Diff two OpenAPI YAML specs (v1 vs v2) and emit a structured markdown changelog listing added endpoints, removed endpoints, modified schemas, and breaking changes.

**Redoc Theme** -- A custom CSS theme for Redoc-based API documentation portals.

**Changelog Template** -- A markdown template for API changelog entries with sections for added, changed, deprecated, removed, fixed, and security updates.

Interactive Preview

Configure API Documentation Toolkit parameters to see how the product works.

Changelog Generator Diff Redoc Theme

Quick Start:

# Run the generator on a sample handler file
python3 src/openapi_from_code.py

# Or import and use in your own script
python3 -c "
from src.openapi_from_code import OpenAPIGenerator
gen = OpenAPIGenerator(title='My API', version='1.0.0')
gen.add_route('GET', '/users', summary='List users', tags=['Us

Key Features:

**Changelog Generator** -- Diff two OpenAPI YAML specs (v1 vs v2) and emit a structured markdown changelog listing added endpoints, removed endpoints, modified schemas, and breaking changes.
**Redoc Theme** -- A custom CSS theme for Redoc-based API documentation portals.
**Changelog Template** -- A markdown template for API changelog entries with sections for added, changed, deprecated, removed, fixed, and security updates.

Interactive demo — some features are simulated. Purchase the full version for complete functionality. View product preview page

📡 API Development — API Documentation Toolkit Demo

Product Content

Interactive Preview

Get the Full API Documentation Toolkit