【AI】 GitHub Copilotでhello worldの作成とコードを説明してもらう

目次

(確認環境:Winodws11、VS code)

GitHub Copilotとは

GitHubが提供するAI駆動型のコーディングアシスタントツールです。

https://github.com/features/copilot?locale=ja

前提条件は以下です。
・GitHub アカウントがある
・GitHub Copilot のライセンスを持っている

VS Codewを使用しています。
また、VS Codeの拡張機能としてGitHub Copilot、GitHub Copilot Chat、Japanese Language Pack for Visual Studio Code(日本語化)をインストールしています。

VS Codeの左側のサイドバーの四角いアイコン(Extensions)でインストール済みか確認できます。

日本語入力からhello worldのコードを作成する

1.ファイルを作成します。ファイル名は、test.pyとします。

 

2.Ctrl + Iをクリックし、入力欄を表示します。

 

3.入力欄に以下のコメントを入力し、右のアイコンをクリックします。

Python で「Hello World」を返す API(FastAPI)を作ってください

 

4.コード案が作成されます。問題なければ「Accept」をクリックします。
「Close」をクリックすると元に戻ります。

 

5.コードが作成されました。

作成されたコード

from fastapi import FastAPI
from fastapi.responses import PlainTextResponse
import uvicorn

app = FastAPI()

@app.get("/", response_class=PlainTextResponse)
async def hello():
  return "Hello World"

if __name__ == "__main__":
  uvicorn.run(app, host="0.0.0.0", port=8000)

コードの説明をしてもらう

Copilot Chat 拡張機能が入っている必要があります
(未導入なら「GitHub Copilot Chat」で検索して追加)

1.7行目の@app.get("/", response_class=PlainTextResponse)についてGitHub Copilotに説明してもらいます。

7行目のコードを選択し、右クリックし、「説明」をクリックします。

 

2.Chat欄に説明が表示されます。

作成された説明

@app.get("/", response_class=PlainTextResponse) は FastAPI のルートデコレータで、HTTP GET メソッドのルート "/" を登録し、そのルートの応答に PlainTextResponse を使うことを指定します。これにより、そのデコレートされた関数が GET / に対するハンドラとなります。

PlainTextResponse を使うと、レスポンスの Content-Type が "text/plain" になり、関数が返す文字列は JSON エンコードされずそのまま生のテキストとしてクライアントに送信されます。非文字列(辞書など)を返すと Python の文字列表現がそのまま送られるため、構造化データには向きません。使用時は from fastapi.responses import PlainTextResponse をインポートしていることを確認してください。

実務上の注意点:デフォルトのステータスコードは 200 です(必要なら status_code を指定できます)。OpenAPI ドキュメントは生成されますが、レスポンスのメディアタイプは text/plain として扱われます。JSON やスキーマ検証が必要な場合は response_model や JSONResponse を検討してください。

関連の記事

【AI】 Cursorでhello worldの作成とコードを説明してもらう
【AI】 Claude Codeでhello worldの作成とコードを説明してもらう

△上に戻る