django ninja

^ Por favor lea ^

Rápido de aprender, rápido de codificar, rápido de ejecutar

Django Ninja: marco REST rápido de Django

Django Ninja es un marco web para crear API con sugerencias de tipo Django y Python 3.6+.

Características clave:

• Fácil : Diseñado para ser fácil de usar e intuitivo.
• Ejecución RÁPIDA : Muy alto rendimiento gracias al soporte de Pydantic y asíncrono .
• Codificación rápida : las sugerencias de escritura y los documentos automáticos le permiten centrarse únicamente en la lógica empresarial.
• Basado en estándares : Basado en los estándares abiertos para API: OpenAPI (anteriormente conocido como Swagger) y JSON Schema .
• Compatible con Django : (obviamente) tiene buena integración con el núcleo de Django y ORM.
• Listo para producción : utilizado por varias empresas en proyectos en vivo (si usa django-ninja y desea publicar sus comentarios, envíe un correo electrónico a [email protected]).

Documentación : https://django-ninja.dev

---

Instalación

 pip install django-ninja

Uso

En su proyecto Django, junto a urls.py, cree un nuevo archivo api.py :

 from ninja import NinjaAPI

api = NinjaAPI ()


@ api . get ( "/add" )
def add ( request , a : int , b : int ):
    return { "result" : a + b }

Ahora vaya a urls.py y agregue lo siguiente:

...
from . api import api

urlpatterns = [
    path ( "admin/" , admin . site . urls ),
    path ( "api/" , api . urls ),  # <---------- !
]

Eso es todo !

Ahora acaba de crear una API que:

• recibe una solicitud HTTP GET en /api/add
• toma, valida y escribe los parámetros GET a y b
• decodifica el resultado a JSON
• genera un esquema OpenAPI para una operación definida

Documentos API interactivos

Ahora vaya a http://127.0.0.1:8000/api/docs

Verá la documentación API interactiva automática (proporcionada por Swagger UI o Redoc):

¿Qué sigue?

• Lea la documentación completa aquí: https://django-ninja.dev
• Para apoyar este proyecto, dale una estrella en Github.
• Compártelo vía Twitter
• Si ya utiliza django-ninja, comparta sus comentarios con [email protected]