Structure for django rest framework.
Project description
Django Rest Structure
This app make your rest api application simple
Document
1. Install by running
pip install django-rest-structure
2. Add middleware to your MIDDLEWARE
(or MIDDLEWARE_CLASSES
) setting like this:
MIDDLEWARE = (
'django_rest_structure.middlewares.middleware.RequestHandlerMiddleware',
...
)
3. Add exception handler to your REST_FRAMEWORK
setting like this:
REST_FRAMEWORK = {
...
'EXCEPTION_HANDLER': 'django_rest_structure.results.exception.exception_handler'
...
}
then add to YOUR-PROJECT/urls.py
handler404 = 'django_rest_structure.api.views.error_view_404'
handler500 = 'django_rest_structure.api.views.error_view_500'
handler403 = 'django_rest_structure.api.views.error_view_403'
handler400 = 'django_rest_structure.api.views.error_view_400'
4. Create your result messages like:
from django_rest_structure.results.codes import ResultMessageStructure
from django_rest_structure.results.exception import ResultMessages
class MyCustomResultMessages(ResultMessages):
CUSTOM_ERROR = ResultMessageStructure(1, 'My Custom Error', False, 500)
# `1` is your result code
# `My Custom Error` is your result message
# `False` define result is success or not
# `500` is http response code
5. Create your custom exception like:
from django_rest_structure.results.exception import Err
class MyCustomError(MyCustomResultMessages, Err):
def __init__(self, *args, **kwargs):
super(MyCustomError, self).__init__(*args, **kwargs)
6. Now you should create your views like:
from django_rest_structure.api.views import BaseApiView
class MyView(BaseApiView):
def post_method(self, request, *args, **kwargs):
result = {}
return ResponseStructure(ResultMessages.GET_SUCCESSFULLY, result)
sample 1:
request data:
{}
response data:
{
"status": {
"code": 200,
"message": "Done",
"is_success": true
},
"result": {}
}
7. Create your serializers like:
1. simple serializers
from django_rest_structure.api.views import BaseApiView
from django_rest_structure.api.serializers import BaseSerializer
from rest_framework import serializers
class MySerializer(BaseSerializer):
my_field = serializers.CharField()
def get_response(self):
# the request available on self.request
response_data = {
'my_field': self.validated_data['my_field']
}
return ResponseStructure(ResultMessages.GET_SUCCESSFULLY, response_data)
class MyView(BaseApiView):
def post_method(self, request, *args, **kwargs):
return MySerializer(request.data, check_is_valid=True, request=request).get_response()
sample 1:
request data:
{
"my_field": "test"
}
response data:
{
"status": {
"code": 200,
"message": "Done",
"is_success": true
},
"result": {
"my_field": "test"
}
}
2. serializer with custom validation
from django_rest_structure.api.views import BaseApiView
from django_rest_structure.api.serializers import BaseSerializer
from django_rest_structure.api.validations import StrFieldValidation
from rest_framework import serializers
def my_field_vld(value, **extra_params):
return value.upper()
class MySerializer(BaseSerializer):
# returned object from StrFieldValidation is available on validated_data
my_field = serializers.CharField(validators=[StrFieldValidation(
regex=r'^[A-Za-z]+$',
error_message='just enter alphabet',
extra_function=my_field_vld
)])
def get_response(self):
# the request available on self.request
response_data = {
'my_field': self.validated_data['my_field']
}
return ResponseStructure(ResultMessages.GET_SUCCESSFULLY, response_data)
class MyView(BaseApiView):
def post_method(self, request, *args, **kwargs):
return MySerializer(request.data, check_is_valid=True, request=request).get_response()
sample 1:
request data:
{
"my_field": "@"
}
response data:
{
"status": {
"code": 406,
"message": "Entered Data Is Not Valid",
"is_success": false
},
"result": {
"my_field": [
"enter just alphabet"
]
}
}
sample 2:
request data:
{
"my_field": "Test"
}
response data:
{
"status": {
"code": 200,
"message": "Done",
"is_success": true
},
"result": {
"my_field": "TEST"
}
}
3. list serializer
from django_rest_structure.api.views import BaseApiView
from django_rest_structure.api.serializers import MyListSerializer
class MySerializer(MyListSerializer):
def get_response(self):
# the request available on self.request
my_list = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']
response_data = self.paging_structure(
*self.paging(my_list)
)
return ResponseStructure(ResultMessages.GET_SUCCESSFULLY, response_data)
class MyView(BaseApiView):
def post_method(self, request, *args, **kwargs):
return MySerializer(request.data, check_is_valid=True, request=request).get_response()
sample 1:
request data:
{
"page": 1,
"count": 5
}
response data:
{
"status": {
"code": 200,
"message": "Done",
"is_success": true
},
"result": {
"list": [
"a",
"b",
"c",
"d",
"e"
],
"page": 1,
"count_in_page": 5,
"total_count": 12
}
}
8. Config your settings
change structure response function by adding to your settings.py
REST_STRUCTURE_CONF = {
'response_handler': 'django_rest_structure.results.structure.response_structure'
}
define your custom function like:
def response_structure(response):
return {
'status': {
'code': response.message.code,
'message': response.message.message,
'is_success': response.message.is_success_result,
},
'result': response.body
}
change logging handler function by adding to your settings.py
REST_STRUCTURE_CONF = {
'log_handler': 'django_rest_structure.logs.console.emmit',
}
define your custom function like:
import logging
logger = logging.Logger('console')
def emmit(request, response, error, request_time, response_time):
if error is not None:
logger.debug(error)
9. You can see the simple project that use from this package at: django_rest_structure_sample
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-rest-structure-1.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3162eabd2b5ca5bd52b9ab3bc3e74ab9c9fad452cdfa256096d3ae806650d53 |
|
MD5 | 429bbe312f1a374cd6640388f3ffc1a2 |
|
BLAKE2b-256 | dfbc99178fab84e69529c3f5157ca42bbd4a29aa17442c8f57bb53b69a3b5761 |
Close
Hashes for django_rest_structure-1.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42ba722117fdba8c0d356b6eb4f10f75e76e5551488b31ac9f97d45a782e2c76 |
|
MD5 | 0c9ea4d600a1ebb6cbbaceac447cbd3b |
|
BLAKE2b-256 | 23e73b183a97c1db368148d17c99213d7c04469ca2a568bf69da9d89b9e9378d |