django api generator

Gerador de API do Django

Ferramenta simples que gera APIs seguras no topo do DRF com o mínimo esforço - suportado ativamente pelo aplicativo -gerador .

• Django - Construir serviços sem codificação - Apresentação em vídeo

---

Para um conjunto completo de recursos e suporte a longo prazo, confira o dinâmico Django , um poderoso iniciante que incorpora:

• Datatíveis dinâmicos: usando uma única linha de configuração, os dados salvos em qualquer tabela são gerenciados automaticamente
• API dinâmica: qualquer modelo pode se tornar um endpoint seguro da API usando DRF
• Gráficos dinâmicos: extrair gráficos relevantes sem codificar todos os principais tipos são suportados
• Carregador de CSV: traduzir arquivos CSV em modelos django e (opcional) carregar as informações
• Ferramentas CLI poderosas para a interface Git, edição de configuração, atualizando a configuração e o banco de dados (crie modelos, migrar dB)

Características

• API engine fornecido por DRF
• Protegido por JWT Tokens (solicitações de mutação)
• Minimal Configuration (linha única na configuração para cada modelo)
• Handles any model definido em todo o projeto
• Lógica de acesso CRUD :
  • READ é público (todos os itens, obtenha item por id)
  • Mutating requests são protegidos por JWT Tokens

Como usá -lo

Etapa 1 - Install the package

$ pip install django-api-generator
// OR
$ pip install git+https://github.com/app-generator/django-api-generator.git

Etapa 2 - Update Configuration , inclua os novos aplicativos

 INSTALLED_APPS = [
    'django_api_gen' ,            # Django API GENERATOR  # <-- NEW
    'rest_framework' ,            # Include DRF           # <-- NEW 
    'rest_framework.authtoken' ,  # Include DRF Auth      # <-- NEW   
]

Etapa #3 - Register the model em core/settings.py (seção API_Generator)

Este código de amostra assume que app1 existe e Book de modelos é definido e migrado.

 API_GENERATOR = {
    # pattern: 
    # API_SLUG -> Import_PATH 
    'books'  : "app1.models.Book" ,
}

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES' : [
        'rest_framework.authentication.SessionAuthentication' ,
        'rest_framework.authentication.TokenAuthentication' ,
    ],
}

Etapa #4 - Migrate DB e crie as tabelas usadas por DRF

$ python manage.py makemigrations
$ python manage.py migrate

Etapa 5 - Generate API

$ python manage.py generate-api
// OR 
$ python manage.py generate-api -f # supress confirmation (forcing mode)

O código é gerado na pasta api na raiz do projeto. Em cada iteração, o código da API é substituído .

Etapa 6 - Update routing , inclua APIs

 from django . contrib import admin
from django . urls import path , include                        # <-- UPD: 'include` directive
from rest_framework . authtoken . views import obtain_auth_token # <-- NEW

urlpatterns = [
    path ( "admin/" , admin . site . urls ),
    path ( "api/" ,   include ( "api.urls" )),        # <-- NEW
    path ( 'login/jwt/' , view = obtain_auth_token ), # <-- NEW
]    

Etapa 7 - Use API

Se o modelo gerenciado for Books , a interface da API é /api/books/ e todos os métodos CRUD estarão disponíveis.

Nota: Para solicitações de mutação, o JWT Token é fornecido por http://localhost:8000/login/jwt/ route (o usuário deve existir).

Links e recursos

• DRF - Página inicial
• Mais ferramentas de desenvolvedor fornecidas pela AppSeed
• Peça apoio por Email e Discord

---

Django API Gerator-Biblioteca de código aberto fornecido pelo aplicativo-gerador