<本記事のターゲット層>
- ASP.NET CoreやC#でWeb APIを開発している初学者
- Postmanを毎回起動するのが面倒だと感じている開発者
- コードと一緒にテストケースを管理したいエンジニア
- Visual Studioだけで完結した開発体験を求めている方
はじめに
Web APIを開発していると、「エンドポイントの動作確認がしたい」という場面は日常茶飯事です。
これまでは Postman
や curl
を使ってテストする人が多かったと思いますが、Visual Studio 2022以降では .http
ファイルを使って、IDE内でAPIを手軽にテストできる機能が搭載されています。
本記事では、ASP.NET Coreを使ってWeb APIを開発する初心者向けに、.http
ファイルを使ったAPIテストの方法を画像・サンプル付きでわかりやすく解説します。
.httpファイルとは?
.http
ファイルは、HTTPリクエストをそのままテキストで記述できるファイル形式です。Visual Studioではこのファイルを読み取り、実際にAPIを呼び出すことができます。
例えば以下のように、GETリクエストをそのまま書きます:
### Get all todos
GET https://localhost:5001/todos
Accept: application/json
.http
ファイルは複数のリクエストをまとめて書くことができ、ドキュメント兼テストスクリプトとしても活用可能です。
なぜPostmanの代わりになるの?
- ✅ Visual Studio内でそのまま実行できる
- ✅ コードと一緒にバージョン管理できる(.gitにコミット可能)
- ✅ GUIではなくテキストベースなので、履歴や修正が明確
- ✅ 外部ツールを使わず開発フローを簡素化できる
.httpファイルの使い方(ステップバイステップ)
1. .http
ファイルを作成する
Visual Studio のソリューションエクスプローラーで以下のように作成します:
→ 右クリック → 追加 → 新しい項目 → テキストファイル → 名前を `test.http` に変更
2. APIリクエストを書く
### GET すべてのToDoを取得
GET https://localhost:5001/todos
Accept: application/json
### POST 新しいToDoを追加
POST https://localhost:5001/todos
Content-Type: application/json
{
"id": 3,
"title": "記事を書く",
"isDone": false
}
各リクエストは ###
で区切って複数書けます。
3. 実行方法
-
.http
ファイル内のGET
やPOST
の行の左にある「実行」ボタン(▶)をクリック - 結果がエディタ内に表示され、レスポンス内容・ステータスコード・レスポンスヘッダも確認可能
.httpファイルでできること
機能 | 説明 |
---|---|
リクエストの実行 |
GET , POST , PUT , DELETE などのHTTPメソッドに対応 |
ヘッダーの指定 |
Accept , Authorization , Content-Type など自由に記述可能 |
JSONボディ送信 | JSON形式のリクエストボディもそのまま記述可能 |
複数リクエスト管理 | 1つの.http ファイルで複数のAPIエンドポイントを管理可能 |
環境変数の使用 |
{{host}} など環境変数を定義して使いまわせる |
.httpファイルでの環境変数の使い方
Visual Studioでは .http
ファイルと一緒に .env
ファイルを使うことができます。
.http
ファイル例
GET {{host}}/todos
Accept: application/json
.env
ファイル(同じフォルダに作成)
host=https://localhost:5001
→ このように変数を使えば、ポート番号やURLをまとめて管理できます。
注意点・補足
- Visual StudioのHTTPクライアント機能は2022以降のバージョンが必要です(最新版推奨)
-
.http
ファイルはVisual Studio Codeでも REST Client拡張機能 を使えば利用可能 - HTTPSリクエストを送る場合、開発証明書が正しく設定されていないとエラーになります
Postmanとの違いまとめ
比較項目 | .httpファイル (Visual Studio) | Postman |
---|---|---|
UI | テキストベース | GUIベース |
実行場所 | Visual Studio内 | 専用アプリ |
バージョン管理 | Gitで簡単に管理可能 | エクスポートが必要 |
チーム共有 |
.http ファイルをそのまま共有 |
Postmanコレクションの共有が必要 |
学習コスト | 非常に低い(基本はHTTP文法) | GUI操作が豊富で初心者にも優しい |
おわりに
.http
ファイルを使えば、Visual StudioだけでAPI開発からテストまで一貫して行える環境が整います。特に、Postmanを開くのが面倒だった人・開発スピードを上げたい人にとっては大きなメリットです。
開発と同時にテストもサクッと行い、より快適なASP.NET Coreライフを送りましょう!
関連リンク
もしこの記事が役に立ったら、いいねやストック、コメントをいただけると励みになります 🙌