Changelog

All notable changes to FastOpenAPI will be documented in this file.

[0.6.0] – 2025‑04‑16

The use_aliases parameter was added to the BaseRouter constructor. Default is True. To preserve the previous behavior (without using aliases from Pydantic), set use_aliases=False.

The _serialize_response method is now an instance method (was a @staticmethod) — to support use_aliases.
The _get_model_schema method was temporarily changed from a @classmethod to a regular method — for consistent behavior with use_aliases.

AioHttpRouter for integration with the AIOHTTP framework (async support for AIOHTTP).
Class-level cache for model schemas to improve performance (avoids regenerating JSON Schema for the same Pydantic model repeatedly).
response_errors parameter for route decorators to document error responses in OpenAPI.
error_handler module for standard error responses (provides exceptions like BadRequestError, ResourceNotFoundError, etc., as described in documentation).
Support for using basic Python types (int, float, bool, str) as response_model (for simple responses).

ReDoc UI support. A ReDoc documentation interface is now served at the default URL (e.g., /redoc).
TornadoRouter for integration with the Tornado framework.

Status code for internal error responses: changed from 422 to 500 for unhandled exceptions, providing a more appropriate HTTP status for server errors.

Removed the add_docs_route and add_openapi_route methods from BaseRouter. Documentation routes are now added by default, so these manual methods are no longer needed.

Fixed import issue for routers when a framework is not installed. (Guarded against ModuleNotFoundError if an extra was not installed and its router was imported.)

QuartRouter for integration with the Quart framework (async Flask-like framework).
Initial documentation (introduction and basic usage examples) added to repository.

Import syntax for routers simplified: you can now do from fastopenapi.routers import YourRouter (e.g., FlaskRouter) instead of deeper module paths.

Fixed retrieving parameters for BaseModel arguments in GET routes. Query parameters based on Pydantic models now work correctly.

Fixed an issue in internal response serialization: _serialize_response now correctly handles BaseModel instances by converting them to dict before JSON encoding (preventing a TypeError).
Resolved a bug causing DataLoader to crash when processing empty datasets. (This appears to be an internal utility, possibly used for schema generation.)
Added more tests to cover these scenarios.
Added this CHANGELOG.md file to track changes.

Implemented resolve_endpoint_params in BaseRouter to systematically resolve function parameters (path, query, body) and integrate with Pydantic validation.
Added prefix parameter to the include_router method, allowing grouping routes under a path.
Implemented status_code support for responses in route decorators (could specify default status code for each endpoint).

Refactored all router implementations for consistency and to reduce code duplication.

Removed the register_routes method from Starlette integration (no longer needed after refactor).

Initial release of FastOpenAPI.
Core functionality implemented:
Base classes and structure for routers.
Router support for Falcon, Flask, Sanic, Starlette.
OpenAPI schema generation leveraging Pydantic v2.
Basic validation for query and body parameters.
Included basic documentation in README and a few examples.
Added initial test suite covering basic route registration and schema generation.