A Django app to help make building APIs great.
Project description
Django Dans API Toolkit
Description
A Django app to help make building APIs great.
This app is meant to be a collection of tools to help with common API tasks, and is not meant to be a full-fledged API solution. It is meant to be used in conjunction with Django Rest Framework, and is not a replacement for it.
Quick start
- Install the package via pip:
pip install django-dans-api-toolkit
- Add
django_dans_api_toolkit
to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [
...
'django_dans_api_toolkit',
]
-
Run
python manage.py migrate
to update your database schema. -
Use the API endpoints, in code or your Django admin portal.
Requirements
TODO validate these
- 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
andDEFAULT_PAGINATION_CLASS
in yoursettings.py
to work with the APIs properly. An example config would be:
- NOTE: not only must you have this installed, you must have set
REST_FRAMEWORK = {
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
"PAGE_SIZE": 20,
"DEFAULT_AUTHENTICATION_CLASSES": (
"rest_framework.authentication.TokenAuthentication",
),
}
Features
This app is meant to be a collection of tools to help with common API tasks, and is not meant to be a full-fledged API solution. It is meant to be used in conjunction with Django Rest Framework, and is not a replacement for it.
Some of the features include:
- API response handler -
api_response_handler.py
- API response renderer -
api_response_renderer.py
- Base serializer -
serializers/base.py
https://danielnazarian.com
Copyright 2024 © Daniel Nazarian.
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 Distribution
Built Distribution
Hashes for django-dans-api-toolkit-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b967ca721aa2f00529d50bec6f76ed6f6599e9cfc78d6a59f8925ec0c4875233 |
|
MD5 | f8b932ad7556d64ab4a2db987fa454a6 |
|
BLAKE2b-256 | caa41a647027bc2650ab702378360ed61ebb809fd366d829b97891bfdb489b8e |
Hashes for django_dans_api_toolkit-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc0a52b644c289a65066be4a0e9caaf0aa6641ef3b28f6d285dd86b0e213629e |
|
MD5 | 8d871668b45faeb3a9b5a23652ce63b7 |
|
BLAKE2b-256 | 0ca55f4aef5197a96be0dfa470b3e73398c2b98e3300c71e1dc7b8a07ae0b8a5 |