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

  • 5 мин

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

Что такое API?

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

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

Текущий API не представляет страну или регион, который должен быть реализован для перечисления городов. Маршрут должен разрешать только HTTP-запросы GET с ответом JSON, предоставляющим информацию о исторических максимальных и минимальных значениях для данной страны или региона, города и указанного месяца.

Примечание.

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

Шаг 1. Добавление нового маршрута

Откройте файл main.py и используйте встроенный чат с помощью команды CTRL+i (в Windows) или Command+i (в Mac). Эта команда обращается к GitHub Copilot с просьбой помочь создать новый API для отображения городов страны или региона. Используйте следующий запрос:

Create a new route that exposes the cities of a country/region.

Этот запрос должен дать вам что-то аналогичное этому:

# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
    return list(data[country].keys())

Примечание.

Попробуйте новый маршрут и дорабатывайте ваш запрос, пока результат не станет желаемым.

Шаг 2. Создание теста

Теперь, когда вы создали новый маршрут, создайте тест с Copilot Chat для этого маршрута, который использует Испанию в качестве страны или региона. Не забудьте выбрать код и попросить Copilot Chat помочь вам с этим конкретным API, который мы только что создали. Вы можете использовать встроенный чат или выделенную панель чата со следующим запросом:

/tests help me to create a new test for this route that uses Spain as the country/region.

После того как Copilot поможет вам создать тест, попробуйте его. Если это не работает должным образом, вы можете поделиться этими сведениями с Copilot в чате. Например:

This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.

Шаг 3. Создание документации с помощью агента

Наконец, используйте режим агента чата GitHub Copilot для написания документации по проекту и подробных сведений о том, как запустить сам проект. README.md Откройте файл и используйте следующий запрос в чате GitHub Copilot:

I want to document how to run this project so that other developers can get started quickly by reading the README.md file.

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

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

Завершив упражнение в GitHub, вернитесь сюда, чтобы выполнить следующие задачи:

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