Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dan1229/django_dans_api_toolkit
A Django app with tools to help build better Rest APIs faster
https://github.com/dan1229/django_dans_api_toolkit
Last synced: about 1 month ago
JSON representation
A Django app with tools to help build better Rest APIs faster
- Host: GitHub
- URL: https://github.com/dan1229/django_dans_api_toolkit
- Owner: dan1229
- License: bsd-3-clause
- Created: 2024-04-25T02:53:18.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-23T21:21:40.000Z (6 months ago)
- Last Synced: 2024-11-28T23:38:00.303Z (about 2 months ago)
- Language: Python
- Homepage: https://pypi.org/project/django-dans-api-toolkit/
- Size: 47.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Django Dans API Toolkit
[](https://github.com/dan1229/django_dans_api_toolkit/actions/workflows/python-lint.yml)
[](https://github.com/dan1229/django_dans_api_toolkit/actions/workflows/python-test.yml)
[](https://github.com/dan1229/django_dans_api_toolkit/actions/workflows/python-types.yml)
[](https://codecov.io/gh/dan1229/django_dans_api_toolkit)
[](https://www.python.org/)
[](https://www.djangoproject.com/)
[](https://pypi.org/project/django-dans-api-toolkit/)
[](https://pepy.tech/project/django-dans-api-toolkit)
[](https://github.com/dan1229/django-dans-api-toolkit/blob/main/LICENSE.txt)
[](https://www.codacy.com/app/dan1229/django-dans-api-toolkit)
[](https://github.com/psf/black)
## Description
**Django Dans API Toolkit** is a Django app to help make building APIs great.
It provides a collection of tools for common API tasks, intended to complement Django Rest Framework (DRF) rather than replace it.
[Available on PyPi](https://pypi.org/project/django-dans-api-toolkit/)
## Features
The toolkit includes:
- **API Response Handler** (`api_response_handler.py`): Standardizes API response formats.
- **API Response Renderer** (`api_response_renderer.py`): Ensures consistent response rendering across your APIs.
- **Base Serializer** (`serializers/base.py`): Simplifies serializer creation with masking and reference functionality.
## Quick Start
### Installation
1. **Install the package via pip:**
```bash
pip install django-dans-api-toolkit
```
2. **Add `django_dans_api_toolkit` to your `INSTALLED_APPS` setting:**
```python
INSTALLED_APPS = [
...
'django_dans_api_toolkit',
]
```
3. **Run migrations to update your database schema:**
```bash
python manage.py migrate
```
4. **Use the provided tools in your views and serializers.**
### Example Usage
#### API Response Handler
```python
from django_dans_api_toolkit.api_response_handler import ApiResponseHandler
def my_view(request):
handler = ApiResponseHandler()
data = {"key": "value"}
return handler.response_success(results=data)
```
#### Base Serializer
```python
from django_dans_api_toolkit.serializers.base import BaseSerializer
from myapp.models import MyModel
class MyModelSerializer(BaseSerializer):
class Meta:
model = MyModel
fields = '__all__'
ref_fields = ['field1', 'field2']
masked_fields = ['field3']
```
#### API Response Renderer
Ensure `DEFAULT_AUTHENTICATION_CLASSES` and `DEFAULT_PAGINATION_CLASS` are set in your settings.py for proper API functionality. Set the renderer itself as well.
Example configuration:
```python
REST_FRAMEWORK = {
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
"PAGE_SIZE": 20,
"DEFAULT_AUTHENTICATION_CLASSES": (
"rest_framework.authentication.TokenAuthentication",
),
}
```
### Requirements
- Python 3.10 - 3.11
- Django 3.1 or higher
- Django Rest Framework
- **NOTE:** not only must you have this installed, you must have set `DEFAULT_AUTHENTICATION_CLASSES` and `DEFAULT_PAGINATION_CLASS` in your `settings.py` to work with the APIs properly. An example config would be:
-------------------------------------------------------
##### [https://danielnazarian.com](https://danielnazarian.com)
##### Copyright 2024 © Daniel Nazarian.