# [Django Dynamic API](https://appseed.us/developer-tools/django-dynamic-api/)
Simple tool that **Generates Secure APIs** on top of `DRF` with minimum effort - actively supported by [AppSeed](https://appseed.us/).
<br />
> `Dynamic API Features` - see [video](https://www.youtube.com/watch?v=nPQMUafTrNY) presentation
- `API engine` provided by `DRF`
- `Minimal Configuration` (single line in config for each model)
- `Handles any model` defined across the project
<br />
<br />
## How to use it
<br />
> **Step #1** - `Install the package`
```bash
$ pip install django-dynamic-api
// OR
$ pip install git+https://github.com/app-generator/django-dynamic-api.git
```
<br />
> **Step #2** - `Update Configuration`, include the new APPs
```python
INSTALLED_APPS = [
'django_dyn_api', # Django Dynamic API # <-- NEW
'rest_framework', # Include DRF # <-- NEW
'rest_framework.authtoken', # Include DRF Auth # <-- NEW
]
```
<br />
> **Step #3** - `Register the model` in `core/settings.py` (DYNAMIC_API section)
This sample code assumes that `app1` exists and model `Book` is defined and migrated.
```python
DYNAMIC_API = {
# pattern:
# API_SLUG -> Import_PATH
'books' : "app1.models.Book",
}
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.TokenAuthentication',
],
}
```
<br />
> **Step #4** - `Migrate DB` and create the tables used by `DRF`
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
<br />
> **Step #5** - `Update routing`, include APIs
```python
from django.contrib import admin
from django.urls import path, include # <-- UPD: 'include` directive
from rest_framework.authtoken.views import obtain_auth_token # <-- NEW
urlpatterns = [
path("admin/", admin.site.urls),
path('', include('django_dyn_api.urls')), # <-- NEW
path('login/jwt/', view=obtain_auth_token), # <-- NEW
]
```
<br />
> **Step #6** - `Use API`
If the managed model is `Books`, the API interface is `/api/books/` and all CRUD methods are available.
> Note: for mutating requests, the `JWT Token` is provided by `http://localhost:8000/login/jwt/` route (the user should exist).
<br />
<br />
### Links & resources
- [DRF](https://www.django-rest-framework.org/) - HOMEpage
- More [Developer Tools](https://appseed.us/developer-tools/) provided by `AppSeed`
- Ask for [Support](https://appseed.us/support/) via `Email` & `Discord`
<br />
---
[Django Dynamic API](https://appseed.us/developer-tools/django-dynamic-api/) - Open-source library provided by **[AppSeed](https://appseed.us/)**
