練習 - 使用 GitHub Copilot 更新 Python Web API

  • 5 分鐘

讓我們探索如何使用 GitHub Copilot 的程式碼建議來修改 Python 存放庫，以建立互動式 HTML 表單和應用程式開發介面 (API) 端點。 透過使用此存放庫，您可以快速實際操作一個 Python Web 應用程式，該應用程式提供一個 HTTP 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 Chat 來要求 Copilot 協助您新增遺漏的匯入。

或者，將以下幾行新增至檔案頂端：

import base64
import os

最後，驗證新端點是否正常運作。 透過移至 /docs 端點並確認該端點顯示來進行嘗試。

恭喜，透過練習，您不僅使用了 Copilot 來產生程式碼，而且還以一種互動且有趣的方式來完成它！ 您可以使用 GitHub Copilot 來產生程式碼、撰寫文件、測試應用程式等工作。

當您完成 GitHub 中的練習時，請返回此處以：

  • 快速知識檢定
  • 您已經學到內容的摘要
  • 完成此課程模組獲得的徽章