{"id":16175199,"url":"https://github.com/app-generator/flask-dynamic-api","last_synced_at":"2026-01-20T05:32:13.893Z","repository":{"id":100502791,"uuid":"515596111","full_name":"app-generator/flask-dynamic-api","owner":"app-generator","description":"Flask Dynamic API - Developer Tool | AppSeed","archived":false,"fork":false,"pushed_at":"2023-09-22T06:08:53.000Z","size":26467,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T18:13:28.603Z","etag":null,"topics":["api","appseed","dynamic-programming","flask","open-source"],"latest_commit_sha":null,"homepage":"https://appseed.us","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/app-generator.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2022-07-19T13:26:35.000Z","updated_at":"2024-10-22T20:23:59.000Z","dependencies_parsed_at":"2024-04-17T05:40:15.497Z","dependency_job_id":null,"html_url":"https://github.com/app-generator/flask-dynamic-api","commit_stats":null,"previous_names":["app-generator/flask-dynamic-api"],"tags_count":2,"template":true,"template_full_name":"app-generator/flask-soft-ui-dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-dynamic-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-dynamic-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-dynamic-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-dynamic-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/app-generator","download_url":"https://codeload.github.com/app-generator/flask-dynamic-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247711526,"owners_count":20983529,"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","appseed","dynamic-programming","flask","open-source"],"created_at":"2024-10-10T04:44:21.052Z","updated_at":"2026-01-20T05:32:13.868Z","avatar_url":"https://github.com/app-generator.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flask Dynamic API via `Flask-RestX`\n\nThis tool aims to provide a secure, `production-ready API via Flask-RestX` using the developer's minimum amount of code. \nFor newcomers, **Flask** is a leading backend framework used to code from simple websites and API's to complex eCommerce solutions.\n\n**Flask-RestX** is a popular library for developing secure API services using Flask.\n\n- 👉 Free [support](https://appseed.us/support/) via Email and [Discord](https://discord.gg/fZC6hup)\n- 👉 More [Developer Tools](https://appseed.us/developer-tools/) - provided by AppSeed\n\n## Video Presentation\n\nhttps://user-images.githubusercontent.com/51070104/194328733-3bdf8c70-f765-4168-983d-2a51e276239b.mp4\n\n\u003cbr /\u003e\n\n## Manual Build \n\n\u003e Clone/Download Sources\n\n```bash\n$ git clone https://github.com/app-generator/flask-dynamic-api.git\n$ cd flask-dynamic-api\n```\n\n\u003e Install Modules\n\n```bash\n$ virtualenv env\n$ source env/bin/activate\n$ pip install -r requirements.txt\n```\n\n\u003e Update ENV \n\n```bash\n$ export FLASK_APP=run.py\n```\n\n\u003e Migrate DB \n\n```bash\n$ flask db init     # INIT needs to be executed only once\n$ flask db migrate  # Needs to be executed at each DB Schema Update  \n$ flask db upgrade  # Needs to be executed at each DB Schema Update\n```\n\n\u003e Start the project\n\n```bash\n$ flask run\n```\n\n\u003cbr /\u003e\n\n## How it works\n\nThe **Dynamic API** tool aims to enable a secured API service on top of any Flask codebase with a minimum effort. Here are the steps:\n\n- `Define a new model` in the project (an old one can be also used)\n- `Execute the database migration` to create/update the associated tables\n- `Update the configuration` to enable the Dynamic API over the model\n- `Start the app`\n- Access the `Dynamic API Service`\n\nFor instance, if the new model managed by the Dynamic API is called books, the associate API is exposed at /api/books/\n\n\u003cbr /\u003e\n\n| Status | Item | info | \n| --- | --- | --- |\n| ✅ | New Models Definition in `apps/models` | - |\n| ✅ | The app is saved in `apps/dyn_api` | - |\n| ✅ | Models enabled in `apps/config.py` via `DYNAMIC_API` variable | - |\n| ✅ | The project exposes automatically a CRUD API over the new model | - |\n| ✅ | Path of the service: `/api/books/` | In case the new model is `Books` | \n| ✅ | The API is powered via Flask-RestX using best practices | - | \n\n\u003cbr /\u003e\n\n## API Permissions\n\nBefore using the API, the user must make a request to the `/login' endpoint and send his username and password.:\n\n```json\nPOST /login\n{\n  \"username\": \"my_username\",\n  \"password\": \"my_password\"\n}\n```\n\nThe server returns a token if approved.\n\n```json\n{\n  \"token\": \"RETURNED_TOKEN\"\n}\n```\n\nTo use the features, the user must add a key and value to the headers.\n\nheaders of requests:\n```json\n{\n  ...\n  \"Authorization\": \"token RETURNED_TOKEN\"\n  ...\n}\n```\n**Note:** token will be expired after 24 hours.\n\n\u003cbr /\u003e\n\n---\n**Flask Dynamic API** via `Flask-RestX` - Developer tool provided by [AppSeed](https://appseed.us)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fflask-dynamic-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Fflask-dynamic-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fflask-dynamic-api/lists"}