django ninja

^ Por favor, leia ^

Rápido para aprender, rápido para codificar, rápido para executar

Django Ninja - Estrutura REST rápida do Django

Django Ninja é uma estrutura web para construção de APIs com dicas do tipo Django e Python 3.6+.

Principais recursos:

• Fácil : Projetado para ser fácil de usar e intuitivo.
• Execução RÁPIDA : Desempenho muito alto graças ao suporte Pydantic e assíncrono .
• Rápido para codificar : dicas de digitação e documentos automáticos permitem que você se concentre apenas na lógica de negócios.
• Baseado em padrões : Baseado nos padrões abertos para APIs: OpenAPI (anteriormente conhecido como Swagger) e JSON Schema .
• Django amigável : (obviamente) tem boa integração com o núcleo do Django e ORM.
• Pronto para produção : Usado por várias empresas em projetos ao vivo (se você usa Django-ninja e gostaria de publicar seu feedback, envie um e-mail para [email protected]).

Documentação : https://django-ninja.dev

---

Instalação

 pip install django-ninja

Uso

No seu projeto Django próximo a urls.py crie um novo arquivo api.py :

 from ninja import NinjaAPI

api = NinjaAPI ()


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

Agora vá para urls.py e adicione o seguinte:

...
from . api import api

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

É isso !

Agora você acabou de criar uma API que:

• recebe uma solicitação HTTP GET em /api/add
• pega, valida e converte os parâmetros GET a e b
• decodifica o resultado para JSON
• gera um esquema OpenAPI para operação definida

Documentos interativos da API

Agora vá para http://127.0.0.1:8000/api/docs

Você verá a documentação da API interativa automática (fornecida pelo Swagger UI ou Redoc):

O que vem a seguir?

• Leia a documentação completa aqui - https://django-ninja.dev
• Para apoiar este projeto, dê uma estrela no Github.
• Compartilhe via Twitter
• Se você já usa Django-ninja, compartilhe seus comentários para [email protected]