Skip to content

fastapi-docx

FastAPI

Add HTTPException responses to a FastAPI OpenAPI spec

CI Coverage Package version Supported Python versions

Documentation: https://saran33.github.io/fastapi-docx

Source Code: https://github.com/Saran33/fastapi-docx

FastAPI-docx extends the FastAPI OpenAPI spec to include all possible HTTPException or custom Exception response schemas that may be raised within path operations.

The key features are:

  • Document Exception Responses: Automatically find all possible respones within path operations, whether they originate from a HTTPException raised by the endpoint function directly, in a nested function, class method, or callable class instance, or by the fastAPI dependency-injection system.
  • Include Custom Exceptions: Optionally find and document any custom Exception types if using custom Exception handlers in your FastAPI application.
  • Generate Exception schemas: A default HTTPExceptionSchema will be added to the OpenAPI specification. The default can be modified to use any other Pydantic model. An additional schema for app-specific custom Exceptions can also be included.

License

This project is licensed under the terms of the MIT license.