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.
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-0.1.8.tar.gz
(8.4 kB
view hashes)
Built Distribution
Close
Hashes for fastapi_docx-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 994ce21cd9d8d5deebf05bb72ffcdb8dcaa81e59b27ebf40c2e2c8046ccbfacf |
|
MD5 | a50a19c612b1133846dcca1749d2aa9e |
|
BLAKE2b-256 | 2eed2c54185a0d76521ffe3231eef4f751c89282861e5c7fbdc6a181eb1591b2 |