练习 - 使用 GitHub Copilot 更新 Python Web API

  • 5 分钟

让我们来探讨如何使用 GitHub Copilot 中的代码建议修改 Python 存储库，以创建交互式 HTML 表单和应用程序编程接口 (API) 终结点。 通过使用此存储库，你将很快掌握为 HTTP API 提供服务的 Python Web 应用，该 API 会生成一个通常用于标识例程的伪随机令牌。

什么是 API？

API 充当中介，实现不同的应用程序间的相互通信。 例如，天气网站可以共享历史数据，也可以通过其 API 提供预测功能。 使用 API，可以将数据嵌入网站或创建与其他功能共享天气数据的应用程序。

扩展 Web 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：添加所需的导入项

如果导入 base64 和 os 模块，生成的代码可能会导致应用程序崩溃。 使用 GitHub Copilot 聊天请求 Copilot 帮助你添加缺少的导入内容。

或者在文件的顶部，添加以下行：

import base64
import os

最后，验证新终结点是否正常运行。 通过转到 /docs 终结点并确认终结点出现来试用。

祝贺你，通过练习，你不仅使用 Copilot 生成了代码，还以一种交互且有趣的方式完成了此操作！ 使用 GitHub Copilot 可以生成代码，编写文档、测试应用程序等。

在 GitHub 中完成练习后，请返回此处完成以下内容：

  • 快速知识检查
  • 浏览已学习内容的摘要
  • 完成此模块的徽章