https://github.com/freemindcore/django-api-framework
Async CRUD API with Zero coding. Easy and fast API framework based on Django-Ninja-Extra, inspired by NestJS-CRUD.
https://github.com/freemindcore/django-api-framework
api crud-api django django-api django-api-framework django-crud django-easy-api django-ninja django-ninja-extra python python-async rest rest-api restful
Last synced: 3 days ago
JSON representation
Async CRUD API with Zero coding. Easy and fast API framework based on Django-Ninja-Extra, inspired by NestJS-CRUD.
- Host: GitHub
- URL: https://github.com/freemindcore/django-api-framework
- Owner: freemindcore
- License: mit
- Created: 2022-09-30T16:31:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-22T08:57:06.000Z (about 2 years ago)
- Last Synced: 2025-12-28T10:24:31.875Z (22 days ago)
- Topics: api, crud-api, django, django-api, django-api-framework, django-crud, django-easy-api, django-ninja, django-ninja-extra, python, python-async, rest, rest-api, restful
- Language: Python
- Homepage:
- Size: 1.04 MB
- Stars: 16
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/django-api-framework)
[](https://pypi.python.org/pypi/django-api-framework)
[](https://codecov.io/gh/freemindcore/django-api-framework)
[](https://pepy.tech/project/django-api-framework)
[](https://pypi.python.org/pypi/django-api-framework)
[](https://pypi.python.org/pypi/django-api-framework)
# Easy CRUD API Framework
- Zero code for a full CRUD API: Automatic and configurable, inspired by [NextJs-Crud](https://github.com/nestjsx/crud).
- Async CRUD API with Django RBAC security protection
- Prefetch and retrieve all m2m fields if configured
- Recursively retrieve all FK/OneToOne fields if configured
- Excluding fields you do not want, or define a list of sensitive fields of your choice
- Pure class based [Django-Ninja](https://github.com/vitalik/django-ninja) APIs: thanks to [Django-Ninja-Extra](https://github.com/eadwinCode/django-ninja-extra)
- Domain/Service/Controller Base Structure: for better code organization.
- Base Permission/Response/Exception Classes: and some handy features to help your API coding easier.
```
Django-Ninja features:
Easy: Designed to be easy to use and intuitive.
FAST execution: Very high performance thanks to Pydantic and async support.
Fast to code: Type hints and automatic docs lets you focus only on business logic.
Standards-based: Based on the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema.
Django friendly: (obviously) has good integration with the Django core and ORM.
Plus Extra:
Class Based: Design your APIs in a class based fashion.
Permissions: Protect endpoint(s) at ease with defined permissions and authorizations at route level or controller level.
Dependency Injection: Controller classes supports dependency injection with python Injector or django_injector. Giving you the ability to inject API dependable services to APIController class and utilizing them where needed
```
## Install
`pip install django-api-framework`
Then add "easy" to your django INSTALLED_APPS:
```
[
...,
"easy",
...,
]
```
## Usage
### Get all your Django app CRUD APIs up and running in < 1 min
In your Django project next to urls.py create new apis.py file:
```
from easy.main import EasyAPI
api_admin_v1 = EasyAPI(
urls_namespace="admin_api",
version="v1.0.0",
)
# Automatic Admin API generation
api_admin_v1.auto_create_admin_controllers()
```
Go to urls.py and add the following:
```
from django.urls import path
from .apis import api_admin_v1
urlpatterns = [
path("admin/", admin.site.urls),
path("api_admin/v1/", api_admin_v1.urls), # <---------- !
]
```
Now go to http://127.0.0.1:8000/api_admin/v1/docs
You will see the automatic interactive API documentation (provided by Swagger UI).
### Boilerplate Django project
A boilerplate Django project for quickly getting started, and get production ready easy-apis with 100% test coverage UP and running:
https://github.com/freemindcore/django-easy-api
## Thanks to your help
**_If you find this project useful, please give your stars to support this open-source project. :) Thank you !_**
## Advanced Usage
If `CRUD_API_ENABLED_ALL_APPS` is set to True (default), all app models CRUD apis will be generated.
Apps in the `CRUD_API_EXCLUDE_APPS` list, will always be excluded.
If `CRUD_API_ENABLED_ALL_APPS` is set to False, only apps in the `CRUD_API_INCLUDE_APPS` list will have CRUD apis generated.
Also, configuration is possible for each model, via APIMeta class:
- `generate_crud`: whether to create crud api, default to True
- `model_exclude`: fields to be excluded in Schema
- `model_fields`: fields to be included in Schema, default to `"__all__"`
- `model_join`: prefetch and retrieve all m2m fields, default to False
- `model_recursive`: recursively retrieve FK/OneToOne fields, default to False
- `sensitive_fields`: fields to be ignored
Example:
```
class Category(TestBaseModel):
title = models.CharField(max_length=100)
status = models.PositiveSmallIntegerField(default=1, null=True)
class APIMeta:
generate_crud = True
model_fields = ["field_1", "field_2",] # if not configured default to "__all__"
model_join = True
model_recursive = True
sensitive_fields = ["password", "sensitive_info"]
```
### Adding CRUD APIs to a specific API Controller
By inheriting `CrudAPIController` class, CRUD APIs can be added to any API controller.
Configuration is available via `APIMeta` inner class in your Controller, same as the above `APIMeta` inner class defined in your Django models.
Example:
```
@api_controller("event_api", permissions=[AdminSitePermission])
class EventAPIController(CrudAPIController):
def __init__(self, service: EventService):
super().__init__(service)
class APIMeta:
model = Event # django model
generate_crud = True # whether to create crud api, default to True
model_fields = ["field_1", "field_2",] # if not configured default to "__all__"
model_join = True
model_recursive = True
sensitive_fields = ["password", "sensitive_info"]
```
Please check tests/demo_app for more examples.