django api generator

Джанго генератор API

Простой инструмент, который генерирует безопасные API на вершине DRF с минимальными усилиями - активно поддерживается App -Generator .

• Django - сборка услуг без кодирования - Видео -презентация

---

Для полного набора функций и долгосрочной поддержки, ознакомьтесь с динамическим Django , мощным стартером, который включает в себя:

• Dynamic DataTables: Используя одну строку конфигурации, данные, сохраненные в любой таблице, автоматически управляются
• Динамический API: любая модель может стать безопасной конечной точкой API с помощью DRF
• Динамические диаграммы: извлекать соответствующие диаграммы без кодирования всех основных типов поддерживаются
• CSV Loader: перевести файлы CSV в модели Django и (необязательно) загрузить информацию
• Мощные инструменты CLI для интерфейса GIT, редактирование конфигурации, обновление конфигурации и базы данных (создание моделей, Migrate DB)

Функции

• API engine предоставлен DRF
• Закреплен JWT Tokens (Mutrative Exprings)
• Minimal Configuration (одна строка в конфигурации для каждой модели)
• Handles any model , определенную через проект
• Логика доступа CRUD :
  • READ общедоступно (все элементы, получите товар от id)
  • Mutating requests защищены JWT Tokens

Как его использовать

Шаг № 1 - Install the package

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

Шаг № 2 - Update Configuration , включите новые приложения

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

Шаг № 3 - Register the model в core/settings.py (раздел API_Generator)

Этот пример кода предполагает, что app1 существует и модельная Book определяется и мигрирована.

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

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

Шаг № 4 - Migrate DB и создать таблицы, используемые DRF

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

Шаг № 5 - Generate API

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

Код генерируется в папке api в корне проекта. На каждой итерации код API перезаписан .

Шаг № 6 - Update routing , включайте 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
]    

Шаг № 7 - Use API

Если управляемая модель - это Books , интерфейс API IS /api/books/ и все методы CRUD доступны.

ПРИМЕЧАНИЕ. Для мутирующих запросов JWT Token предоставляется http://localhost:8000/login/jwt/ route (пользователь должен существовать).

Ссылки и ресурсы

• DRF - домашняя страница
• Больше инструментов разработчиков, предоставленных AppSeed
• Попросите поддержку по Email и Discord

---

Django API-генератор-библиотека с открытым исходным кодом