{"id":16175383,"url":"https://github.com/app-generator/devtool-django-api-generator","last_synced_at":"2026-03-07T03:33:12.017Z","repository":{"id":60956637,"uuid":"534508896","full_name":"app-generator/devtool-django-api-generator","owner":"app-generator","description":"Django API Generator - Open-Source Tool for Developers | AppSeed","archived":false,"fork":false,"pushed_at":"2022-10-17T16:22:17.000Z","size":26196,"stargazers_count":12,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-07T18:49:23.003Z","etag":null,"topics":["appseed","django","dynamic-programming","open-source"],"latest_commit_sha":null,"homepage":"https://appseed.us/developer-tools/django-api-generator/","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}},"created_at":"2022-09-09T05:21:41.000Z","updated_at":"2024-08-29T19:44:14.000Z","dependencies_parsed_at":"2023-01-20T03:19:37.650Z","dependency_job_id":null,"html_url":"https://github.com/app-generator/devtool-django-api-generator","commit_stats":null,"previous_names":[],"tags_count":3,"template":true,"template_full_name":"app-generator/django-soft-ui-dashboard","purl":"pkg:github/app-generator/devtool-django-api-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdevtool-django-api-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdevtool-django-api-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdevtool-django-api-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdevtool-django-api-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/app-generator","download_url":"https://codeload.github.com/app-generator/devtool-django-api-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdevtool-django-api-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30206589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T03:24:23.086Z","status":"ssl_error","status_checked_at":"2026-03-07T03:23:11.444Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["appseed","django","dynamic-programming","open-source"],"created_at":"2024-10-10T04:44:44.389Z","updated_at":"2026-03-07T03:33:11.988Z","avatar_url":"https://github.com/app-generator.png","language":"SCSS","readme":"# [Django API Generator](https://appseed.us/developer-tools/django-api-generator/)\n\nThe tool is able to `generate APIs` using **Django \u0026 DRF** stack with a minimum effort. For newcomers, **Django** is a leading backend framework used to code from simple websites and APIs to complex eCommerce solutions.\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\u003cbr /\u003e\n\n## Quick start in `Docker`\n\n\u003e 👉 **Step 1** - Download the code from the GH repository (using `GIT`) \n\n```bash\n$ git clone https://github.com/app-generator/devtool-django-api-generator.git\n$ cd devtool-django-api-generator\n```\n\n\u003cbr /\u003e\n\n\u003e 👉 **Step 2** - Start the APP in `Docker`\n\n```bash\n$ docker-compose up --build \n```\n\nVisit `http://localhost:5085` in your browser. By default a simple [Books](./apps/models.py) Model is used as sample.  \n\n- The generated DRF API is live at `http://localhost:5085/api/books`\n- Registered users can interact with the API using the `API-View` page\n\n\u003cbr /\u003e\n\n![Django API Generator - API View page for Books Model.](https://user-images.githubusercontent.com/51070104/194476781-6476de62-191a-48e8-8730-344c2d63f9d0.png) \n\n\u003cbr /\u003e\n\n## Video Presentation\n\nhttps://user-images.githubusercontent.com/51070104/194480046-fe920d98-e3ac-4c65-9e70-8b752ffaff05.mp4\n\n\u003cbr /\u003e\n\n## How It Works\n\n\u003e 👉 **Step #1** - Define models in `apps/models.py`\n\nBy default, the project comes with a simple `Books` model: \n\n```python\nclass Book(models.Model):\n\n    name = models.CharField(max_length=100)\n```\n\n\u003cbr /\u003e\n\n\u003e 👉 **Step #2** -  `Register the model` in `core/settings.py` (API_GENERATOR section)\n\n```python\nAPI_GENERATOR = {\n    'books': \"Book\", # \u003c-- Books model provided as sample\n}\n```\n\n\u003cbr /\u003e\n\n\u003e 👉 **Step #3** - `Migrate Database`\n\n```bash\n$ python manage.py makemigrations\n$ python manage.py migrate\n```\n\n\u003cbr /\u003e\n\n\u003e 👉 **Step #4** - `Generate API` \n\n```bash\n$ python manage.py generate-api\n```\n\n`Note`: if you define a model that wasn't migrated to db, you will see an error that say names of not migrated models and codes will not generate.\n\n\u003cbr /\u003e\n\n\u003e 👉 **Step #5** - `Use the API` \n\n* Create a book by `POST` request to `/api/books/`\n* Get book that has id = 2 by `GET` request to `/api/books/2/`\n* Get all books by `GET` request to `/api/books/`\n* Update book that has id = 2 by `PUT` request to `/api/books/2/`\n* delete book that has id = 2 by `DELETE` request to `/api/books/2/`\n\n\u003cbr /\u003e\n\n\u003e 👉 **Step #6** - API Authentication\n\nThere are 2 models of authentication that you can use.\n\n\u003e **Token Based Authentication**: send post request to `/login/jwt/` with username and password in body. Api will return a token.\n\n```\nPOST /login/jwt/ {\n    \"username\": \"sth\",\n    \"password\": \"sth\"\n}\n```\n\nThe token should be used in all mutating requests (Create, Update, Delete)\n\n```\n{\n  \"Authorization\": \"token {your token}\"\n}\n```\n\nExample:\n\n```\n{\n  \"Authorization\": \"token b36705e1078b4b67d4dc4f1388a1aee4a754d4cd\"\n}\n```\n\n\u003cbr /\u003e\n\n\u003e **Basic Authentication** \n\nFor users authenticated in the app. \n\n\u003cbr /\u003e\n\n--- \n**[Django API Generator](https://appseed.us/developer-tools/django-api-generator/)** - Developer tool provided by [AppSeed](https://appseed.us)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fdevtool-django-api-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Fdevtool-django-api-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fdevtool-django-api-generator/lists"}