演習 - GitHub Copilot を使用して Python Web API を更新する
GitHub Copilot からのコード提案を使用して Python リポジトリを変更し、対話型の HTML フォームとアプリケーション プログラミング インターフェイス (API) エンドポイントを作成する方法について説明します。 このリポジトリを使用すると、HTTP API を提供する Python Web アプリをすぐに実際に使用できます。この API によって、一般的に識別ルーティンに使用される擬似ランダム トークンが生成されます。
API とは
API は、さまざまなアプリケーションが相互に通信できるようにする仲介役として機能します。 たとえば、気象 Web サイトでは、API を使用して、履歴データを共有したり、予測機能を提供したりできます。 API を使用して、Web サイトにデータを埋め込んだり、他の機能と共に気象データを共有するアプリケーションを作成したりできます。
Web API を拡張する
この API には、トークンを生成するための 1 つのエンドポイントが既に用意されています。 テキストを受け取り、トークンの一覧を返す新しいエンドポイントを追加して、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 で演習を終えたら、以下のためにここに戻ります。
- 簡単な知識チェック
- 学習した内容のまとめ
- このモジュールを修了するためのバッジ