{"id":27140395,"url":"https://github.com/alexdemure/gadopenapi","last_synced_at":"2025-04-08T05:52:01.679Z","repository":{"id":284367456,"uuid":"954061212","full_name":"AlexDemure/gadopenapi","owner":"AlexDemure","description":"Customize and override OpenAPI schema details in FastAPI with ease","archived":false,"fork":false,"pushed_at":"2025-04-07T13:45:18.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"production","last_synced_at":"2025-04-07T14:16:34.529Z","etag":null,"topics":["fastapi","fastapi-extension","openapi","openapi-codegen"],"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/AlexDemure.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":"2025-03-24T14:00:31.000Z","updated_at":"2025-04-07T13:45:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"e898eef3-0b71-49ce-8b27-dab810d93e75","html_url":"https://github.com/AlexDemure/gadopenapi","commit_stats":null,"previous_names":["alexdemure/fastoas","alexdemure/gadopenapi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexDemure%2Fgadopenapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexDemure%2Fgadopenapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexDemure%2Fgadopenapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexDemure%2Fgadopenapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlexDemure","download_url":"https://codeload.github.com/AlexDemure/gadopenapi/tar.gz/refs/heads/production","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247785943,"owners_count":20995644,"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","fastapi-extension","openapi","openapi-codegen"],"created_at":"2025-04-08T05:52:00.873Z","updated_at":"2025-04-08T05:52:01.660Z","avatar_url":"https://github.com/AlexDemure.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/AlexDemure/gadopenapi\"\u003e\n    \u003ca href=\"https://ibb.co/6cqwTKh6\"\u003e\u003cimg src=\"https://i.ibb.co/zWtxB3cK/logo.png\" alt=\"logo\" border=\"0\"\u003e\u003c/a\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Utility toolkit to modify and override OpenAPI schema definitions in FastAPI.\n\u003c/p\u003e\n\n---\n\n## Installation\n\n```\npip install gadopenapi\n```\n\n## Usage\n```\nfrom gadopenapi import OpenAPI\n\napp.openapi = OpenAPI(app)\n```\n\n### Extension ```gadopenapi.extensions.affix```\n\n```\nfrom fastapi import FastAPI\nfrom pydantic import BaseModel\n\nfrom gadopenapi import OpenAPI\nfrom gadopenapi.extensions.affix import affix\n\napp = FastAPI()\n\napp.openapi = OpenAPI(app, handlers=[affix])\n\n\nclass Deprecated(BaseModel):\n    __affix__ = \"Deprecated:\"\n\n\nclass User(Deprecated):\n    id: int\n\n\n@app.get(\"/user\", response_model=User)\ndef get_user():\n    return {\"id\": 1}\n\nopenapi.json\n\u003e\u003e\u003e\n{\n  \"paths\": {\n    \"schema\": {\n      \"$ref\": \"#/components/schemas/DeprecatedUser\"\n    }\n  },\n  \"schemas\": {\n      \"DeprecatedUser\": {\n        \"title\": \"DeprecatedUser\"\n      }\n    }\n}\n```\n\n### Extension ```gadopenapi.extensions.operationid```\n\n```\nfrom fastapi import FastAPI\nfrom pydantic import BaseModel\n\nfrom gadopenapi import OpenAPI\nfrom gadopenapi.extensions.operationid import use_route_as_operation_id\n\napp = FastAPI()\n\napp.openapi = OpenAPI(app, handlers=[use_route_as_operation_id])\n\n\nclass User(BaseModel):\n    id: int\n\n\n@app.get(\"/user\", response_model=User)\ndef get_user():\n    return {\"id\": 1}\n\nopenapi.json\n\u003e\u003e\u003e BEFORE\n{\n  \"paths\": {\n    \"/user\": {\n      \"get\": {\n        \"operationId\": \"get_user_user_get\",\n      }\n    }\n  }\n}\n\n\u003e\u003e\u003e AFTER\n{\n  \"paths\": {\n    \"/user\": {\n      \"get\": {\n        \"operationId\": \"get_user\",\n      }\n    }\n  }\n}\n```\n\n### Extension ```gadopenapi.extensions.errors``` \n\n```\nfrom fastapi import FastAPI\nfrom gadopenapi.extensions.errors import APIError, openapi_errors\n\napp = FastAPI()\n\n\nclass MyError(APIError):\n    ...\n\n\n@app.get(\"/user\", response_model=dict, responses=openapi_errors(MyError))\ndef get_user():\n    return {\"id\": 1}\n\nopenapi.json\n\u003e\u003e\u003e\n{\n  \"paths\": {\n    \"/user\": {\n      \"get\": {\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Successful Response\"\n          },\n          \"418\": {\n            \"description\": \"MyError\",\n            \"content\": {\n              \"application/json\": {\n                \"example\": {\n                  \"status_code\": 418,\n                  \"detail\": {\n                    \"type\": \"MyError\"\n                  }\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}\n```\n\n\n### Custom handler\n\n```\nfrom fastapi import FastAPI\nfrom gadopenapi import OpenAPI\n\ndef my_handler(app: FastAPI, openapi: dict) -\u003e tuple[FastAPI, dict]:\n    # Mutate openapi here\n    return app, openapi\n\napp = FastAPI()\n\napp.openapi = OpenAPI(app, handlers=[my_handler])\n\n@app.get(\"/user\", response_model=dict)\ndef get_user():\n    return {\"id\": 1}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexdemure%2Fgadopenapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexdemure%2Fgadopenapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexdemure%2Fgadopenapi/lists"}