Skip to main content

Django Easy API - Easy and Fast Django REST framework based on Django-ninja-extra

Project description

Test PyPI version PyPI version PyPI version PyPI version Codecov Downloads

Django Easy API Framework

Easy and Fast Django REST framework based on Django-ninja-extra

  • Auto CRUD Async API generation for all django models, configurable via Meta class
  • Domain/Service/Controller base structure for better code organization
  • Base Permission/Response/Exception classes and more to come
  • Pure class based Django-ninja APIs, based on Django-Ninja-extra
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

Requirements

  • Python >= 3.6
  • Django >= 3.1
  • pydantic >= 1.6
  • Django-Ninja-extra >= 0.15.0

Install

pip install django-api-framework

Then add "easy" to your django INSTALLED_APPS:

[
    ...,
    "easy",
    ...,
]

Get your admin api up and running:

api_admin_v1 = EasyAPI(
    urls_namespace="admin_api",
    version="v1.0.0",
)

# Automatic Admin API generation
api_admin_v1.auto_create_admin_controllers()

Please check tests/demo_app for more.

Boilerplate Django project

A boilerplate Django project for quickly getting started: https://github.com/freemindcore/django-easy-api

Auto generated APIs List Auto generated APIs - Users

Note: this project is still in early stage, comments and advices are highly appreciated.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-api-framework-0.1.17.tar.gz (463.2 kB view hashes)

Uploaded Source

Built Distribution

django_api_framework-0.1.17-py3-none-any.whl (21.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page