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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30b46f84f9506741b0d34040d6e42287a593610be9ea224c5d24a8482f82fceb |
|
MD5 | c9b91946c96b269808128483bffc9088 |
|
BLAKE2b-256 | e93edb38e82506d469f29104e42e70181d27e2556d6825237aa8ad798eeed40c |
Hashes for django_dans_api_toolkit-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49e08c28232e8a9b969164e5f4b66c129bd356ca4b8fcced92007395d8fe5140 |
|
MD5 | 0bab308df0f6c2566f0a9cca813b8fad |
|
BLAKE2b-256 | dd2e5a498d28e3f6b7f7ceed972f78b34fcc56559e98a475c8ec515c48584347 |