django rest starter kit

Django Rest Framework Starter Kit

Это стартовый шаблон для проектов Django Rest Framework (DRF), предназначенных для обеспечения прочной основы с основными функциями, обычно необходимыми для разработки API.

Функции

• Аутентификация на основе токков : защищайте свои конечные точки API с помощью аутентификации на основе токков.
• Документация API Swagger : автоматически генерируйте интерактивную документацию API с использованием Cwagger UI.
• Система управления пользователями : реализовать регистрацию пользователей, вход в систему, вход и сброс пароля.
• Разрешения и роли : определите роли пользователей и разрешения для контроля доступа к конечным точкам API.
• Уведомления по электронной почте : Настройка уведомлений по электронной почте для событий, связанных с пользователем, таких как регистрация и сброс пароля.
• Ограничение ставок : предотвратить злоупотребление конечными точками API путем реализации ограничения ставок.
• Загрузка файлов : Поддержка файлов загрузки (например, изображения, документы) с настраиваемыми бэкэнами для хранения.
• Кэширование : улучшить производительность API с помощью кэширования для часто доступных данных.
• Фоновые задачи : выполнять фоновые задачи асинхронно с помощью сельдерея и брокера сообщения.
• Мониторинг и ведение журнала : мониторинг производительности приложения и ошибки отслеживания с помощью инструментов ведения журнала и мониторинга.

Использование

1. Клонировать это хранилище:

   git clone https://github.com/hossainchisty/django-rest-starter-kit.git

2. Установить зависимости:

   pip install -r requirements.txt

3. Настройте настройки:

   • Настройте настройки базы данных в settings.py .
   • Настройте конфигурацию электронной почты для отправки уведомлений.
   • Настройка настроек аутентификации токена.
   • Настройте разрешения и роли в соответствии с требованиями вашей заявки.

4. Мигрировать базу данных:

   python manage.py migrate

5. Запустите сервер разработки:

   python manage.py runserver

6. Доступ к документации API:

   Откройте свой браузер и перейдите на http://127.0.0.1:8000/swagger/ , чтобы просмотреть интерактивную документацию API, сгенерированную Swagger UI.

7. Начните строить свои конечные точки API:

   • Определите свои конечные точки API в urls.py
   • Реализуйте представления и сериализаторы для ваших ресурсов API в views.py и serializers.py соответственно.
   • Защитите свои конечные точки, используя аутентификацию токена и определите разрешения по мере необходимости.

Тестирование

Запустите модульные тесты и интеграционные тесты, чтобы обеспечить надежность и стабильность вашего API:

python manage.py test 

Внося

Взносы приветствуются! Если у вас есть предложения по улучшению или новым функциям, откройте проблему или отправьте запрос на привлечение.

Лицензия

Этот проект лицензирован по лицензии Apache -2.0 - см. Файл лицензии для получения подробной информации.