Создание веб-API Python с открытым исходным кодом с использованием Django REST Framework (часть вторая)

Добро пожаловать во вторую часть создания веб-API Python с открытым исходным кодом с использованием платформы Django. Первая часть руководства посвящена названию API, тип выбранной системы управления базами данных, выбранная структура для проекта и почему мы выбрали эти инструменты.

Во второй части руководства будет описан API и показаны все сущности и атрибуты нашей базы данных, а также показано, как настроить REST API Python. Мы также преобразуем сущности и атрибуты в таблицы и поля и завершим эту часть настройкой нашего проекта Django в виртуальной среде.

Планирование веб-приложения

Прежде чем мы перейдем к написанию кода, давайте задумаемся о структуре нашего проекта. Я советую вам не пропускать этот раздел, потому что мозговой штурм, планирование и использование диаграмм для нашего проекта значительно сократят время, затрачиваемое на написание логики кода для веб-API REST Python.

Строгих правил планирования работы не существует, но запись идей в блокноте, запись и систематизация требований и даже генерация псевдокода сэкономят вам массу времени на этапе написания кода.

При планировании веб-API REST для Python использовались различные правила мозгового штурма и формулирования различных требований. На приведенной ниже диаграмме показана реляционная диаграмма сущностей начальной итерации структуры Python REST Tribal API. По мере разработки приложения мы продолжим уточнять требования приложения. Я указал, что мы строим приложение с нуля. Этот опыт даст нам представление о том, что происходит в реальных проектах.

Схема ER Tribal API

Связь между таблицами веб-API REST Python

Веб-API Python REST будет содержать отношения, существующие между таблицами в базе данных нашего веб-API REST Python с открытым исходным кодом. Ниже приведены отношения между нашими таблицами в первой итерации нашего веб-API python REST с использованием платформы Django REST API.

Племя – регионы:

Каждое племя закреплено за отдельной территорией в зависимости от его местоположения. В одном регионе могут сосуществовать несколько племен.

Племя – демографические данные. Каждое племя имеет свой демографический состав. Демографические данные могут различаться между племенами.

Регионы – страны; каждый регион относится к одной стране. Страны могут иметь много регионов. п

Экономическая деятельность – страны. Вся экономическая деятельность связана с одной или несколькими странами. Экономическая активность может различаться в зависимости от ВВП и отрасли страны.

Культурные традиции — племена; каждое племя имеет свою культуру и традиции. В зависимости от обычаев, религии и поведения племенные культурные традиции могут различаться.

Окружающая среда – регионы; у каждого региона есть свой набор элементов окружающей среды. Климат, природные ресурсы и загрязнение окружающей среды могут привести к различным экологическим проблемам в разных местах.

Здоровье и хорошее самочувствие – племена. У каждого племени есть свои обычаи, связанные со здоровьем и благополучием. В зависимости от диеты, системы здравоохранения, физических упражнений, здоровья и самочувствия у разных племен могут различаться.

Традиционный орган – страна

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

Демография – Здоровье и благополучие:

Каждая демографическая группа имеет свой собственный набор моделей поведения, связанных со здоровьем и благополучием. Возраст, пол, этническая принадлежность и уровень образования влияют на здоровье и самочувствие.

Настройка веб-API на виртуальной машине

Я использую Ubuntu Jammy, вам следует провести небольшое исследование и выяснить, как настроить виртуальную среду в вашей операционной системе. Виртуальная среда помогает изолировать наши зависимости веб-API от взаимодействия с глобальными модулями и пакетами Python.

# Create the project directory
mkdir tribal_project
cd tribal_project

# Create a virtual environment
python3 -m venv env
source env/bin/activate

Узнайте, как создать виртуальную среду в конкретной операционной системе. Создайте приложение Django REST framework, tribal_project, в своей виртуальной среде и запустите новое приложение REST API с именем tribal_app, как показано ниже.

# Install Django and Django REST framework into the virtual environment
pip install django
pip install djangorestframework

# You may install all at once
pip install django djangorestframework

# Set up a new project with a single application
django-admin startproject tribal_project .  # Note the period at the end of the command

cd tribal_project # if you did not add the period at the end of the command

# Install the tribal_app
django-admin startapp tribal_app

Откройте IDE или редактор кода по вашему выбору. Я использую код Visual Studio. Убедитесь, что среда разработки python установлена ​​в коде Visual Studio. Находясь в корневом каталоге проекта, запустите приведенный ниже код.

code . #Take of the period

Все прошло хорошо, вы должны иметь такой тип расположения файлов в вашем проводнике vs code.

Кроме того, установите следующее расширение для быстрой разработки с использованием python и кода. Программа форматирования Python, Pylance, Lightrun и Black.

Третья часть нашей работы пойдет прямо на кодирование веб-приложения. Приготовьтесь к долгой поездке. Еще раз, мы никогда не прекращаем учиться. Удачи и увидимся в следующих сериях.