Extend a FastAPI OpenAPI spec to include all possible HTTPException or custom Exception response schemas.
Project description
fastapi-docx
Add HTTPException responses to a FastAPI OpenAPI spec
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.
Dependencies
- Pydantic V2: From version 1.0 of fastapi-docx, Pydantic V2 is required. For Pydantic V1 support, use fastapi-docx version 0.2.
License
This project is licensed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fastapi_docx-1.0.1.tar.gz
(8.7 kB
view hashes)
Built Distribution
Close
Hashes for fastapi_docx-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36ef00bd0dc14ebaab16c514722e823075376e8eb345a17845370fb212f90aff |
|
MD5 | 74282f2cef0ebc2b6825a9605ef6666b |
|
BLAKE2b-256 | 0d4df5dcc5db984d0bba57e08ca4661eacc1fe994b7ed0de89871b32f0a868d5 |