DRF Standardized Response
Standarize your API responses
Table of Contents
Installation
- Install the package using pip:
pip install drf-standardized-response
- Add
drf_standardized_responsetoINSTALLED_APPS
INSTALLED_APPS = [
...,
"drf_standardized_response",
]
- Add renderer for all API views
"DEFAULT_RENDERER_CLASSES": [
...,
"drf_standardized_response.renderers.StandardizedJSONRenderer",
...,
]
Now, your API responses will be standardized.
How It Works
The package takes care of standardization all responses returned by views.
- if you return a
stringresponse, it will be wrapped in amessagekey. For example:
class MyView(APIView):
def get(self, request):
return Response("Thanks for using DRF Standardized Response")
The response will be:
{
"success": true,
"message": "Thanks for using DRF Standardized Response"
}
- If your response data contains
message, it will override the standardized message.
class MyView(APIView):
def get(self, request):
return Response({"message": "Thanks for using DRF Standardized Response"})
The response will be:
{
"success": true,
"message": "Thanks for using DRF Standardized Response"
}
- if you return a
dictresponse, it will be wrapped in adatakey. For demostration, we will return a user profile.
class MyView(APIView):
def get(self, request):
user = request.user
data = UserProfileSerializer(user).data
return Response(data)
The response will be:
{
"success": true,
"message": "OK",
"data": { # user profile },
}
- if you return a
listortupleresponse, it will be wrapped in adatakey. For demostration, we will return a list of user profiles.
class MyView(APIView):
def get(self, request):
users = User.objects.all()
data = UserProfileSerializer(users, many=True).data
return Response(data)
The response will be:
{
"success": true,
"message": "OK",
"data": [ # list of user profiles ],
}
Customizing
Custom Wrapper Key
You can customize the key used to wrap the response data. By default, the key is data. To change it, set the DEFAULT_WRAPPER_KEY in pkg settings.
DRF_STANDARDIZED_RESPONSE = {
"DEFAULT_WRAPPER_KEY": "results",
}
Or you can change it per view basis using the wrapper_key argument in the view:
class MyView(APIView):
wrapper_key = "results"
Excluded Fields From Wrapping
You can exclude fields from wrapping. By default, the fields are links. To customize it, Set the DEFFAULT_WRAPPING_EXCLUDED_FIELDS in pkg settings.
DRF_STANDARDIZED_RESPONSE = {
"DEFFAULT_WRAPPING_EXCLUDED_FIELDS": ["links", "meta"],
}
Or you can change it per view basis using the wrapping_excluded_fields argument in the view:
class MyView(APIView):
wrapping_excluded_fields = ["links", "meta"]
Wrapping Paginated Response
By default, paginated responses are not wrapped. To customize this behavior, Set the WRAP_PAGINATED_RESPONSE in pkg settings.
DRF_STANDARDIZED_RESPONSE = {
"WRAP_PAGINATED_RESPONSE": True,
}
Disable Standardization On View
You can disable standardization on a view by setting the should_strandardize property to False.
class MyView(APIView):
should_strandardize = False
Custom Response Standarizer
You can also provide your own response standarizer to format response to your desired format. By default, the standarizer is drf_standardized_response.response_standarizer.ResponseStandardizer, which is well suitable for most projects.
But if you need that, set the RESPONSE_STANDARDIZER_CLASS in pkg settings.
DRF_STANDARDIZED_RESPONSE = {
"RESPONSE_STANDARDIZER_CLASS": "your_app.response_standarizer.CustomResponseStandardizer",
}
DRF-Spectacular Integration
If you plan to use drf-spectacular to generate an OpenAPI 3 schema,
install with pip:
pip install drf-standardized-response[openapi].
After that, Set the default schema class to the one provided by the package
REST_FRAMEWORK = {
# other settings
"DEFAULT_SCHEMA_CLASS": "drf_standardized_response.openapi.AutoSchema"
}
Alternatively, you can use the drf_standardized_response.openapi.StandardizedAutoSchemaMixin mixin to your own schema class. (useful when using drf-standardized-errors).
Now, the OpenAPI schema will be generated with the standardized response format.
Disable Schema Standardization On Serializer
You can disable openapi schema standardization on a serializer by setting the should_standardize_schema property to False on Meta.
class MySerializer(serializers.Serializer):
class Meta:
should_standardize_schema = False
Contributing
Contributions are more than welcome! Please open an issue if you have any questions or suggestions.
Metadata
Release files for drf-standardized-response 1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| drf_standardized_response-1.tar.gz | 7.3 kB | Without provenance | Details for drf_standardized_response-1.tar.gz |
Release files / drf_standardized_response-1.tar.gz
| Download URL | drf_standardized_response-1.tar.gz |
|---|---|
| Size | 7.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fb2b3f58013798a997df352ba4b710fcd94effa92e54b60d30543f3424e78720
|
|
BLAKE2b-256 checksum How to use checksums |
3416eaabdece2ae4e03c2a9728111dd3d9bd1251df5e18e8345c0e8d55effffb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
Security for drf-standardized-response 1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.