Get Autogenerated Serializers and APi End Points
Project description
Autogenerated Api
Get Autogenerated Serializers and API EndPoints
Installing autogenerated-api
autogenerated-api built for django.
PyPi, install using PIP:
pip install autogenerated_api
Customizable Files in Apps
django_app architecture looks like
- appp_name
- __init__.py
- models.py
- serializers.py
- filters.py
- tests.py
- views.py
serilizers.py
from models import ModelName
from autogenerated_api.serializers import DeadlySerializerFactory
ModelNameDeadlySerializer = DeadlySerializerFactory(modelName)
filters.py
from models import ModelName
from autogenerated_api.autogeneration import make_model_filter
ModelNameFilter = make_model_filter(ModelName)
views.py
import app_name.models
import app_name.serializers
import app_name.filters
from autogenerated_api.autogeneration import make_all_viewsets
make_all_viewsets(__name__)
Create a new file api_urls.py
in main project folder.
Main project folder Architecture
- main_proj_name
- __init__.py
- settings.py
- urls.py
- wsgi.py
- api_urls.py
Add below codes in api_urls.py
file.
from django.conf.urls import url,include
import app_name.views
from autogenerated_api import autogenerated_urls
urlpatterns = autogenerated_urls.urlpatterns
urlpatterns += []
Adding to URLs
Add the Below urls.py
urlpatterns = [
url(r'^api/', include('project_name.api_urls', namespace='api'),),
]
Customizable Fields in Settings.
AUTOGENERATE_APPS = ["app_name"]
Finally, you will get autogenerated seraializers and end points.
- Autogenerated End Points
- `/api/model_name_in_lower/` : list out all the model_instance
- `/api/model_name_in_lower/<instance_id>` : you will get detail of instance of given id
Why use autogenerated_api?
Usually , people have to create a serializers for each and every models of an app. In most of the cases , while creating a mdelserializer we have to write same amount of code.
To get the list of model instance , we have to write an api end points , like ListAPiView
and for getting the detail of each record , we implement DetailAPIView or RetrieveApiView
.
Now , we don't have to create these APi-end points and get worry about the serailizers . This module will take care of the rest.
Soon, i will release this module with more funtionality and autogenertaed end points .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for autogenerated_api-1.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2d537e7b0ee538c012f578372278d120b53ee9a90778588627a2505a3f8e444 |
|
MD5 | 55205a07e2f6d8703545569dfb926cc3 |
|
BLAKE2b-256 | 914d4ce971a75249633b7fa86cf60d0bb1b7961737b5b925b0817e39e64f96a9 |