{"id":13424715,"url":"https://github.com/awtkns/fastapi-crudrouter","last_synced_at":"2025-05-14T14:08:26.507Z","repository":{"id":37740618,"uuid":"322936836","full_name":"awtkns/fastapi-crudrouter","owner":"awtkns","description":"A dynamic FastAPI router that automatically creates CRUD routes for your models","archived":false,"fork":false,"pushed_at":"2023-11-01T12:10:38.000Z","size":1368,"stargazers_count":1501,"open_issues_count":67,"forks_count":168,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-13T07:09:11.110Z","etag":null,"topics":["api","async","asyncio","code-generation","crud","crud-routes","fastapi","fastapi-crudrouter","framework","openapi","openapi-route","python","python3","redoc","rest","sql","swagger-ui","web"],"latest_commit_sha":null,"homepage":"https://fastapi-crudrouter.awtkns.com","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/awtkns.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"github":"awtkns","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-12-19T20:58:44.000Z","updated_at":"2025-05-12T21:27:05.000Z","dependencies_parsed_at":"2024-01-03T02:29:56.725Z","dependency_job_id":"6db3ea10-56a4-4720-b808-2c89788efe8b","html_url":"https://github.com/awtkns/fastapi-crudrouter","commit_stats":{"total_commits":411,"total_committers":23,"mean_commits":"17.869565217391305","dds":"0.36009732360097324","last_synced_commit":"9b829865d85113a3f16f94c029502a9a584d47bb"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awtkns%2Ffastapi-crudrouter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awtkns%2Ffastapi-crudrouter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awtkns%2Ffastapi-crudrouter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awtkns%2Ffastapi-crudrouter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/awtkns","download_url":"https://codeload.github.com/awtkns/fastapi-crudrouter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254159780,"owners_count":22024564,"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":["api","async","asyncio","code-generation","crud","crud-routes","fastapi","fastapi-crudrouter","framework","openapi","openapi-route","python","python3","redoc","rest","sql","swagger-ui","web"],"created_at":"2024-07-31T00:00:58.225Z","updated_at":"2025-05-14T14:08:26.474Z","avatar_url":"https://github.com/awtkns.png","language":"Python","funding_links":["https://github.com/sponsors/awtkns"],"categories":["Third-Party Extensions","Python","APIs"],"sub_categories":["Utils"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/awtkns/fastapi-crudrouter/master/docs/en/docs/assets/logo.png\" height=\"200\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cem\u003e⚡ Create CRUD routes with lighting speed\u003c/em\u003e ⚡\u003c/br\u003e\n  \u003csub\u003eA dynamic FastAPI router that automatically creates CRUD routes for your models\u003c/sub\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003cimg alt=\"Tests\" src=\"https://img.shields.io/github/actions/workflow/status/awtkns/fastapi-crudrouter/.github/workflows/pytest.yml?color=%2334D058\" /\u003e\n\u003cimg alt=\"Downloads\" src=\"https://img.shields.io/pypi/dm/fastapi-crudrouter?color=%2334D058\" /\u003e\n  \u003ca href=\"https://pypi.org/project/fastapi-crudrouter\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/fastapi-crudrouter?color=%2334D058\u0026label=pypi%20package\" alt=\"Package version\"\u003e\n\u003c/a\u003e\n  \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/awtkns/fastapi-crudrouter?color=%2334D058\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003cimg alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/fastapi-crudrouter\"\u003e\n\u003c/p\u003e\n\n---\n\n**Documentation**: \u003ca href=\"https://fastapi-crudrouter.awtkns.com\" target=\"_blank\"\u003ehttps://fastapi-crudrouter.awtkns.com\u003c/a\u003e\n\n**Source Code**: \u003ca href=\"https://github.com/awtkns/fastapi-crudrouter\" target=\"_blank\"\u003ehttps://github.com/awtkns/fastapi-crudrouter\u003c/a\u003e\n\n---\nTired of rewriting generic CRUD routes? Need to rapidly prototype a feature for a presentation\nor a hackathon? Thankfully, [fastapi-crudrouter](https://github.com/awtkns/fastapi-crudrouter) has your back. As an \nextension to the APIRouter included with [FastAPI](https://fastapi.tiangolo.com/), the FastAPI CRUDRouter will automatically\ngenerate and document your CRUD routes for you, all you have to do is pass your model and maybe your database connection.\n\nFastAPI-CRUDRouter is **lighting fast**, well tested, and **production ready**.\n\n\n## Installation\n```bash\npip install fastapi-crudrouter\n```\n\n## Basic Usage\nBelow is a simple example of what the CRUDRouter can do. In just ten lines of code, you can generate all \nthe crud routes you need for any model. A full list of the routes generated can be found [here](https://fastapi-crudrouter.awtkns.com/routing).\n\n```python\nfrom pydantic import BaseModel\nfrom fastapi import FastAPI\nfrom fastapi_crudrouter import MemoryCRUDRouter as CRUDRouter\n\nclass Potato(BaseModel):\n    id: int\n    color: str\n    mass: float\n\napp = FastAPI()\napp.include_router(CRUDRouter(schema=Potato))\n```\n\n## Advanced Usage\nfastapi-crudrouter provides a number of features that allow you to get the most out of your automatically generated CRUD\nroutes. Listed below are some highlights.\n\n- Automatic Pagination ([docs](https://fastapi-crudrouter.awtkns.com/pagination/))\n- Ability to Provide Custom Create and Update Schemas ([docs](https://fastapi-crudrouter.awtkns.com/schemas/))\n- Dynamic Generation of Create and Update Schemas ([docs](https://fastapi-crudrouter.awtkns.com/schemas/))\n- Ability to Add, Customize, or Disable Specific Routes ([docs](https://fastapi-crudrouter.awtkns.com/routing/))\n- Native Support for FastAPI Dependency Injection ([docs](https://fastapi-crudrouter.awtkns.com/dependencies/))\n\n## Supported Backends / ORMs\nfastapi-crudrouter currently supports a number of backends / ORMs. Listed below are the backends currently supported. This list will\nlikely grow in future releases.\n\n- In Memory ([docs](https://fastapi-crudrouter.awtkns.com/backends/memory/))\n- SQLAlchemy ([docs](https://fastapi-crudrouter.awtkns.com/backends/sqlalchemy/))\n- Databases (async) ([docs](https://fastapi-crudrouter.awtkns.com/backends/async/))\n- Gino (async) ([docs](https://fastapi-crudrouter.awtkns.com/backends/gino.html)) \n- Ormar (async) ([docs](https://fastapi-crudrouter.awtkns.com/backends/ormar/))\n- Tortoise ORM  (async) ([docs](https://fastapi-crudrouter.awtkns.com/backends/tortoise/))\n\n## OpenAPI Support\nBy default, all routes generated by the CRUDRouter will be documented according to OpenAPI spec.\n\nBelow are the default routes created by the CRUDRouter shown in the generated OpenAPI documentation.\n\n![OpenAPI Route Overview](https://raw.githubusercontent.com/awtkns/fastapi-crudrouter/master/docs/en/docs/assets/RouteOverview.png)\n\nThe CRUDRouter is able to dynamically generate detailed documentation based on the models given to it.\n\n![OpenAPI Route Detail](https://raw.githubusercontent.com/awtkns/fastapi-crudrouter/master/docs/en/docs/assets/RouteDetail.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fawtkns%2Ffastapi-crudrouter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fawtkns%2Ffastapi-crudrouter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fawtkns%2Ffastapi-crudrouter/lists"}