{"id":15288720,"url":"https://github.com/saran33/fastapi-docx","last_synced_at":"2025-04-13T06:32:14.208Z","repository":{"id":65421399,"uuid":"584419882","full_name":"Saran33/fastapi-docx","owner":"Saran33","description":"Extend a FastAPI OpenAPI spec to include all possible HTTPException or custom Exception response schemas..","archived":false,"fork":false,"pushed_at":"2025-01-31T02:51:57.000Z","size":1366,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-22T13:45:51.573Z","etag":null,"topics":["fastapi","openapi","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Saran33.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-02T14:14:51.000Z","updated_at":"2025-01-31T02:51:56.000Z","dependencies_parsed_at":"2025-01-31T03:32:14.685Z","dependency_job_id":null,"html_url":"https://github.com/Saran33/fastapi-docx","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saran33%2Ffastapi-docx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saran33%2Ffastapi-docx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saran33%2Ffastapi-docx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saran33%2Ffastapi-docx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Saran33","download_url":"https://codeload.github.com/Saran33/fastapi-docx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248674674,"owners_count":21143760,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","openapi","python"],"created_at":"2024-09-30T15:52:27.751Z","updated_at":"2025-04-13T06:32:13.549Z","avatar_url":"https://github.com/Saran33.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fastapi-docx\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Saran33/fastapi-docx\"\u003e\u003cimg src=\"https://saran33.github.io/fastapi-docx/img/fastapi-docx-logo-teal.png\" alt=\"FastAPI\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003cem\u003eAdd HTTPException responses to a FastAPI OpenAPI spec\u003c/em\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/saran33/fastapi-docx/actions?query=workflow%3ACI+event%3Apush+branch%3Amain\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://github.com/saran33/fastapi-docx/workflows/CI/badge.svg?event=push\u0026branch=main\" alt=\"CI\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://saran33.github.io/fastapi-docx/coverage/coverage.html\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://saran33.github.io/fastapi-docx/coverage/coverage-badge.svg\" alt=\"Coverage\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://pypi.org/project/fastapi-docx\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/fastapi-docx?color=%2334D058\u0026label=pypi%20package\" alt=\"Package version\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://pypi.org/project/fastapi-docx\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/pyversions/fastapi-docx\" alt=\"Supported Python versions\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n**Documentation**: \u003ca href=\"https://saran33.github.io/fastapi-docx\" target=\"_blank\"\u003ehttps://saran33.github.io/fastapi-docx\u003c/a\u003e\n\n**Source Code**: \u003ca href=\"https://github.com/Saran33/fastapi-docx\" target=\"_blank\"\u003ehttps://github.com/Saran33/fastapi-docx\u003c/a\u003e\n\n---\n\nFastAPI-docx extends the FastAPI OpenAPI spec to include all possible `HTTPException` or custom Exception response schemas that may be raised within path operations.\n\nThe key features are:\n\n* **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.\n* **Include Custom Exceptions**: Optionally find and document any custom Exception types if using custom Exception handlers in your FastAPI application.\n* **Generate Exception schemas**: A default `HTTPExceptionSchema` will be added to the OpenAPI specification. The default can be modified to use any other [Pydantic](*https://github.com/pydantic/pydantic) model. An additional schema for app-specific custom Exceptions can also be included.\n\n\n##### Dependencies\n* [Pydantic V2](https://github.com/pydantic/pydantic): From version 1.0 of fastapi-docx, Pydantic V2 is required. For Pydantic V1 support, use fastapi-docx version 0.2.\n\n##### License\nThis project is licensed under the terms of the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaran33%2Ffastapi-docx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaran33%2Ffastapi-docx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaran33%2Ffastapi-docx/lists"}