Упражнение. Обновление веб-API Python с помощью GitHub Copilot

  • 5 мин

Давайте рассмотрим, как изменить репозиторий Python с помощью предложений кода из GitHub Copilot, чтобы создать интерактивную HTML-форму и конечную точку интерфейса программирования приложений (API). Работая с этим репозиторием, вы быстро получаете практические сведения с веб-приложением Python, которое служит HTTP-API, который создает псевдо-случайный токен, часто используемый в процедурах идентификации.

Что такое API?

API выступает в качестве посредника, который позволяет различным приложениям взаимодействовать друг с другом. Например, веб-сайт погоды может совместно использовать исторические данные или предоставлять функции прогнозирования через свой API. С помощью API можно внедрить данные на веб-сайт или создать данные о погоде приложения, совместное с другими функциями.

Расширение веб-API

API уже имеет одну конечную точку для создания маркера. Давайте обновим API, добавив новую конечную точку, которая принимает текст и возвращает список маркеров.

Примечание.

В этом упражнении используйте пространство Codespace с предварительно настроенной средой в браузере.

Шаг 1. Добавление модели Pydantic

Перейдите main.py к файлу и добавьте комментарий, чтобы GitHub Copilot смог создать Pydantic модель для вас. Созданная модель должна выглядеть следующим образом:

class Text(BaseModel):

text: str

Шаг 2. Создание новой конечной точки

Затем создайте новую конечную точку с помощью GitHub Copilot, добавив комментарий:

# Create a FastAPI endpoint that accepts a POST request with a JSON body containing a single field called "text" and returns a checksum of the text

Шаг 3. Добавление необходимых импортов

Созданный код может привести к сбою приложения, если base64os модули не импортируются. Используйте чат GitHub Copilot, чтобы попросить Copilot помочь вам добавить отсутствующие импорты.

Кроме того, добавьте следующие строки в начало файла:

import base64
import os

Наконец, убедитесь, что новая конечная точка работает. Попробуйте выполнить его, перейдя к конечной точке /docs и убедив, что конечная точка отображается.

Поздравляем, через упражнение, вы не только использовали Copilot для создания кода, но и сделали это в интерактивном и веселом способе! Вы можете использовать GitHub Copilot для создания кода, написания документации, тестирования приложений и т. д.

Завершив упражнение в GitHub, вернитесь сюда:

  • пройти быструю проверку знаний;
  • подвести итоги по изученному материалу;
  • Значок за прохождение этого модуля.