HttpRepl を使用して Web API をテストする

[アーティクル]
11/30/2023

HTTP Read-Eval-Print Loop (REPL) は:

.NET Core がサポートされているすべての場所でサポートされている、軽量なクロスプラットフォームコマンドラインツールです。
ASP.NET Core Web API (および ASP.NET 以外の Core Web API) をテストし、その結果を表示する HTTP 要求を作成するために使用されます。
localhost や Azure App Service などの任意の環境でホストされている Web API をテストすることができます。

次の HTTP 動詞がサポートされています。

DELETE
GET
HEAD
OPTIONS
PATCH
投稿
PUT

先に進むには、サンプル ASP.NET Core Web API を表示またはダウンロードします (ダウンロード方法)。

前提条件

.NET Core 3.1 SDK

インストール

HttpRepl をインストールするには、次のコマンドを実行します。

dotnet tool install -g Microsoft.dotnet-httprepl

.Net Core グローバルツールは、Microsoft.dotnet-httprepl NuGet パッケージからインストールされます。

Note

既定では、インストールする .NET バイナリのアーキテクチャは、現在実行中の OS アーキテクチャを表します。別の OS アーキテクチャを指定するには、「dotnet tool install, --arch option」を参照してください。詳細については、GitHub イシュー dotnet/AspNetCore.Docs #29262 を参照してください。

macOS で、次のパスを更新します。

export PATH="$HOME/.dotnet/tools:$PATH"

使用法

ツールのインストールが正常に完了したら、次のコマンドを実行して HttpRepl を開始します。

httprepl

使用可能な HttpRepl コマンドを表示するには、次のコマンドのいずれかを実行します。

httprepl -h

httprepl --help

次の出力が表示されます。

Usage:
  httprepl [<BASE_ADDRESS>] [options]

Arguments:
  <BASE_ADDRESS> - The initial base address for the REPL.

Options:
  -h|--help - Show help information.

Once the REPL starts, these commands are valid:

Setup Commands:
Use these commands to configure the tool for your API server

connect        Configures the directory structure and base address of the api server
set header     Sets or clears a header for all requests. e.g. `set header content-type application/json`

HTTP Commands:
Use these commands to execute requests against your application.

GET            get - Issues a GET request
POST           post - Issues a POST request
PUT            put - Issues a PUT request
DELETE         delete - Issues a DELETE request
PATCH          patch - Issues a PATCH request
HEAD           head - Issues a HEAD request
OPTIONS        options - Issues a OPTIONS request

Navigation Commands:
The REPL allows you to navigate your URL space and focus on specific APIs that you are working on.

ls             Show all endpoints for the current path
cd             Append the given directory to the currently selected path, or move up a path when using `cd ..`

Shell Commands:
Use these commands to interact with the REPL shell.

clear          Removes all text from the shell
echo [on/off]  Turns request echoing on or off, show the request that was made when using request commands
exit           Exit the shell

REPL Customization Commands:
Use these commands to customize the REPL behavior.

pref [get/set] Allows viewing or changing preferences, e.g. 'pref set editor.command.default 'C:\\Program Files\\Microsoft VS Code\\Code.exe'`
run            Runs the script at the given path. A script is a set of commands that can be typed with one command per line
ui             Displays the Swagger UI page, if available, in the default browser

Use `help <COMMAND>` for more detail on an individual command. e.g. `help get`.
For detailed tool info, see https://aka.ms/http-repl-doc.

HttpRepl では、コマンド補完が提供されています。 Tab キーを押すと、入力した文字または API エンドポイントを補完するコマンドの一覧が反復処理されます。次のセクションでは、使用可能な CLI コマンドの概要を示します。

Web API に接続する

次のコマンドを実行して、Web API に接続します。

httprepl <ROOT URI>

<ROOT URI> は、Web API のベース URI です。次に例を示します。

httprepl https://localhost:5001

または、HttpRepl の実行中に、次のコマンドをいつでも実行します。

connect <ROOT URI>

次に例を示します。

(Disconnected)> connect https://localhost:5001

Web API の OpenAPI の説明を手動でポイントする

上記の connect コマンドでは、自動的に OpenAPI の説明の検索が試みられます。何らかの理由でそれができない場合は、--openapi オプションを使用して、Web API の OpenAPI の説明の URI を指定できます。

connect <ROOT URI> --openapi <OPENAPI DESCRIPTION ADDRESS>

次に例を示します。

(Disconnected)> connect https://localhost:5001 --openapi /swagger/v1/swagger.json

OpenAPI の説明の検索、解析、検証に関する詳細の詳細出力を有効にする

connect コマンドで --verbose オプションを指定すると、ツールで OpenAPI の説明が検索され、解析、検証される場合に、詳細が生成されます。

connect <ROOT URI> --verbose

次に例を示します。

(Disconnected)> connect https://localhost:5001 --verbose
Checking https://localhost:5001/swagger.json... 404 NotFound
Checking https://localhost:5001/swagger/v1/swagger.json... 404 NotFound
Checking https://localhost:5001/openapi.json... Found
Parsing... Successful (with warnings)
The field 'info' in 'document' object is REQUIRED [#/info]
The field 'paths' in 'document' object is REQUIRED [#/paths]

Web API 内を移動する

使用可能なエンドポイントを表示する

Web API アドレスの現在のパスにあるさまざまなエンドポイント (コントローラー) を一覧表示するには、ls コマンドまたは dir コマンドを実行します。

https://localhost:5001/> ls

次の出力形式が表示されます。

.        []
Fruits   [get|post]
People   [get|post]

https://localhost:5001/>

前の出力では、Fruits と People の 2 つのコントローラーが使用可能であることが示されています。どちらのコントローラーでも、パラメーターなしの HTTP GET 操作と POST 操作がサポートされます。

特定のコントローラーに移動すると、詳細がわかります。たとえば、次のコマンドの出力は、Fruits コントローラーが HTTP GET、PUT、DELETE の各操作をサポートしていることを示しています。これらの各操作には、ルートで id パラメーターが必要です。

https://localhost:5001/fruits> ls
.      [get|post]
..     []
{id}   [get|put|delete]

https://localhost:5001/fruits>

または、ui コマンドを実行して、ブラウザーで Web API の Swagger UI ページを開きます。次に例を示します。

https://localhost:5001/> ui

エンドポイントに移動する

Web API の別のエンドポイントに移動するには、cd コマンドを実行します。

https://localhost:5001/> cd people

cd コマンドの後のパスでは大文字と小文字が区別されません。次の出力形式が表示されます。

/people    [get|post]

https://localhost:5001/people>

HttpRepl をカスタマイズする

HttpRepl の既定の色はカスタマイズできます。また、既定のテキストエディターを定義することもできます。 HttpRepl の設定は、現在のセッションで永続化され、今後のセッションで受け入れられます。変更した設定は、次のファイルに格納されます。

%HOME%/.httpreplprefs

.httpreplprefs ファイルは起動時に読み込まれ、実行時の変更は監視されません。ファイルに対する手動の変更は、ツールを再起動した後でのみ有効になります。

設定を表示する

使用可能な設定を表示するには、pref get コマンドを実行します。次に例を示します。

https://localhost:5001/> pref get

上記のコマンドでは、使用可能なキーと値のペアが表示されます。

colors.json=Green
colors.json.arrayBrace=BoldCyan
colors.json.comma=BoldYellow
colors.json.name=BoldMagenta
colors.json.nameSeparator=BoldWhite
colors.json.objectBrace=Cyan
colors.protocol=BoldGreen
colors.status=BoldYellow

色の設定を設定する

応答の色付けは、現在、JSON でのみサポートされています。既定の HttpRepl ツールの色分けをカスタマイズするには、変更する色に対応するキーを見つけます。キーを検索する方法については、「設定を表示する」セクションを参照してください。たとえば、次のように、colors.json キー値を Green から White に変更します。

https://localhost:5001/people> pref set colors.json White

使用できるのは、許可されている色だけです。後続の HTTP 要求では、出力が新しい色で表示されます。

特定の色キーが設定されていない場合、より汎用的なキーが考慮されます。このフォールバック動作を示すために、次の例を考えてみます。

colors.json.name に値がない場合は、colors.json.string が使用されます。
colors.json.string に値がない場合は、colors.json.literal が使用されます。
colors.json.literal に値がない場合は、colors.json が使用されます。
colors.json 値がない場合は、コマンドシェルの既定のテキストの色 (AllowedColors.None) が使用されます。

インデントのサイズを設定する

応答インデントサイズのカスタマイズは、現在、JSON でのみサポートされています。既定のサイズは 2 つのスペースです。次に例を示します。

[
  {
    "id": 1,
    "name": "Apple"
  },
  {
    "id": 2,
    "name": "Orange"
  },
  {
    "id": 3,
    "name": "Strawberry"
  }
]

既定のサイズを変更するには、formatting.json.indentSize キーを設定します。たとえば、常に 4 つのスペースを使用するには、次のようにします。

pref set formatting.json.indentSize 4

後続の応答では、4 つのスペースの設定が優先されます。

[
    {
        "id": 1,
        "name": "Apple"
    },
    {
        "id": 2,
        "name": "Orange"
    },
    {
        "id": 3,
        "name": "Strawberry"
    }
]

既定のテキストエディターを設定する

既定では、HttpRepl には、使用するように構成されたテキストエディターはありません。 HTTP 要求本文を必要とする Web API メソッドをテストするには、既定のテキストエディターを設定する必要があります。 HttpRepl ツールによって、要求本文を作成する目的のためだけに構成されたテキストエディターが起動します。次のコマンドを実行して、優先テキストエディターを既定値として設定します。

pref set editor.command.default "<EXECUTABLE>"

上記のコマンドで、<EXECUTABLE> はテキストエディターの実行可能ファイルへの完全なパスです。たとえば、次のコマンドを実行して、既定のテキストエディターとして Visual Studio Code を設定します。

pref set editor.command.default "/usr/bin/code"

pref set editor.command.default "/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code"

pref set editor.command.default "C:\Program Files\Microsoft VS Code\Code.exe"

特定の CLI 引数を使用して既定のテキストエディターを起動するには、editor.command.default.arguments キーを設定します。たとえば、Visual Studio Code が既定のテキストエディターで、拡張機能が無効になっている新しいセッションでは HttpRepl で常に Visual Studio Code を開きたいとします。次のコマンドを実行します。

pref set editor.command.default.arguments "--disable-extensions --new-window"

ヒント

既定のエディターが Visual Studio Code 場合、通常、-w または --wait 引数を渡して、Visual Studio Code に、ファイルが閉じられてから戻るように待機させます。

OpenAPI の説明の検索パスを設定する

HttpRepl には既定の相対パスのセットがあり、connect コマンドが --openapi オプションを指定せずに実行された場合に、それを使用して OpenAPI の説明が検索されます。これらの相対パスは、connect コマンドで指定されているルートパスおよびベースパスと組み合わされます。既定の相対パスは次のとおりです。

swagger.json
swagger/v1/swagger.json
/swagger.json
/swagger/v1/swagger.json
openapi.json
/openapi.json

環境で別の検索パスのセットを使用するには、ユーザー設定 swagger.searchPaths を設定します。値としては、パイプで区切られた相対パスのリストを指定する必要があります。次に例を示します。

pref set swagger.searchPaths "swagger/v2/swagger.json|swagger/v3/swagger.json"

既定のリストを完全に置き換えるのではなく、パスを追加または削除してリストを変更することもできます。

既定のリストに 1 つ以上の検索パスを追加するには、swagger.addToSearchPaths 設定を指定します。値としては、パイプで区切られた相対パスのリストを指定する必要があります。次に例を示します。

pref set swagger.addToSearchPaths "openapi/v2/openapi.json|openapi/v3/openapi.json"

既定のリストから 1 つ以上の検索パスを削除するには、swagger.addToSearchPaths 設定を指定します。値としては、パイプで区切られた相対パスのリストを指定する必要があります。次に例を示します。

pref set swagger.removeFromSearchPaths "swagger.json|/swagger.json"

HTTP GET 要求をテストする

構文

get <PARAMETER> [-F|--no-formatting] [-h|--header] [--response:body] [--response:headers] [-s|--streaming]

引数

PARAMETER

関連付けられたコントローラーアクションメソッドで求められるルートパラメーター (存在する場合)。

[オプション]

get コマンドには以下のオプションを使用できます。

-F|--no-formatting

存在することで HTTP 応答の書式設定を抑制するフラグ。
-h|--header

HTTP 要求ヘッダーを設定します。次の 2 つの値の形式がサポートされています。
- {header}={value}
- {header}:{value}
--response:body

HTTP 応答の本文を書き込むファイルを指定します。たとえば、「 --response:body "C:\response.json" 」のように入力します。ファイルが存在しない場合は作成されます。
--response:headers

HTTP 応答のヘッダーを書き込むファイルを指定します。たとえば、「 --response:headers "C:\response.txt" 」のように入力します。ファイルが存在しない場合は作成されます。
-s|--streaming

存在することで HTTP 応答のストリーミングを有効にするフラグ。

例

HTTP GET 要求を発行するには、次のようにします。

それをサポートしているエンドポイントで get コマンドを実行します。

https://localhost:5001/people> get

上記のコマンドでは、次の出力形式が表示されます。

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 21 Jun 2019 03:38:45 GMT
Server: Kestrel
Transfer-Encoding: chunked

[
  {
    "id": 1,
    "name": "Scott Hunter"
  },
  {
    "id": 2,
    "name": "Scott Hanselman"
  },
  {
    "id": 3,
    "name": "Scott Guthrie"
  }
]


https://localhost:5001/people>

get コマンドにパラメーターを渡すことによって、特定のレコードを取得します。

https://localhost:5001/people> get 2

上記のコマンドでは、次の出力形式が表示されます。

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 21 Jun 2019 06:17:57 GMT
Server: Kestrel
Transfer-Encoding: chunked

[
  {
    "id": 2,
    "name": "Scott Hanselman"
  }
]


https://localhost:5001/people>

HTTP POST 要求をテストする

構文

post <PARAMETER> [-c|--content] [-f|--file] [-h|--header] [--no-body] [-F|--no-formatting] [--response] [--response:body] [--response:headers] [-s|--streaming]

引数

PARAMETER

関連付けられたコントローラーアクションメソッドで求められるルートパラメーター (存在する場合)。

[オプション]

-F|--no-formatting

存在することで HTTP 応答の書式設定を抑制するフラグ。
-h|--header

HTTP 要求ヘッダーを設定します。次の 2 つの値の形式がサポートされています。
- {header}={value}
- {header}:{value}
--response:body

HTTP 応答の本文を書き込むファイルを指定します。たとえば、「 --response:body "C:\response.json" 」のように入力します。ファイルが存在しない場合は作成されます。
--response:headers

HTTP 応答のヘッダーを書き込むファイルを指定します。たとえば、「 --response:headers "C:\response.txt" 」のように入力します。ファイルが存在しない場合は作成されます。
-s|--streaming

存在することで HTTP 応答のストリーミングを有効にするフラグ。

-c|--content

インライン HTTP 要求本文を提供します。たとえば、「 -c "{\"id\":2,\"name\":\"Cherry\"}" 」のように入力します。
-f|--file

HTTP 要求本文を含むファイルへのパスを提供します。たとえば、「 -f "C:\request.json" 」のように入力します。
--no-body

HTTP 要求本文が不要であることを示します。

例

HTTP POST 要求を発行するには、次のようにします。

それをサポートしているエンドポイントで post コマンドを実行します。
```
https://localhost:5001/people> post -h Content-Type=application/json
```
前のコマンドでは、Content-Type HTTP 要求ヘッダーが JSON の要求本文メディアの種類を示すように設定されています。既定のテキストエディターでは、HTTP 要求本文を表す JSON テンプレートを含む .tmp ファイルが開かれます。次に例を示します。
```
{
  "id": 0,
  "name": ""
}
```
ヒント

既定のテキストエディターを設定するには、「既定のテキストエディターを設定する」セクションを参照してください。
モデルの検証要件を満たすように JSON テンプレートを変更します。
```
{
  "id": 0,
  "name": "Scott Addie"
}
```

.tmp ファイルを保存して、テキストエディターを閉じます。コマンドシェルに次の出力が表示されます。

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Date: Thu, 27 Jun 2019 21:24:18 GMT
Location: https://localhost:5001/people/4
Server: Kestrel
Transfer-Encoding: chunked

{
  "id": 4,
  "name": "Scott Addie"
}


https://localhost:5001/people>

HTTP PUT 要求をテストする

構文

put <PARAMETER> [-c|--content] [-f|--file] [-h|--header] [--no-body] [-F|--no-formatting] [--response] [--response:body] [--response:headers] [-s|--streaming]

引数

PARAMETER

関連付けられたコントローラーアクションメソッドで求められるルートパラメーター (存在する場合)。

[オプション]

-F|--no-formatting

存在することで HTTP 応答の書式設定を抑制するフラグ。
-h|--header

HTTP 要求ヘッダーを設定します。次の 2 つの値の形式がサポートされています。
- {header}={value}
- {header}:{value}
--response:body

HTTP 応答の本文を書き込むファイルを指定します。たとえば、「 --response:body "C:\response.json" 」のように入力します。ファイルが存在しない場合は作成されます。
--response:headers

HTTP 応答のヘッダーを書き込むファイルを指定します。たとえば、「 --response:headers "C:\response.txt" 」のように入力します。ファイルが存在しない場合は作成されます。
-s|--streaming

存在することで HTTP 応答のストリーミングを有効にするフラグ。

-c|--content

インライン HTTP 要求本文を提供します。たとえば、「 -c "{\"id\":2,\"name\":\"Cherry\"}" 」のように入力します。
-f|--file

HTTP 要求本文を含むファイルへのパスを提供します。たとえば、「 -f "C:\request.json" 」のように入力します。
--no-body

HTTP 要求本文が不要であることを示します。

例

HTTP PUT 要求を発行するには、次のようにします。

省略可能: 変更前にデータを表示するには、get コマンドを実行します。

https://localhost:5001/fruits> get
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sat, 22 Jun 2019 00:07:32 GMT
Server: Kestrel
Transfer-Encoding: chunked

[
  {
    "id": 1,
    "data": "Apple"
  },
  {
    "id": 2,
    "data": "Orange"
  },
  {
    "id": 3,
    "data": "Strawberry"
  }
]

それをサポートしているエンドポイントで put コマンドを実行します。
```
https://localhost:5001/fruits> put 2 -h Content-Type=application/json
```
前のコマンドでは、Content-Type HTTP 要求ヘッダーが JSON の要求本文メディアの種類を示すように設定されています。既定のテキストエディターでは、HTTP 要求本文を表す JSON テンプレートを含む .tmp ファイルが開かれます。次に例を示します。
```
{
  "id": 0,
  "name": ""
}
```
ヒント

既定のテキストエディターを設定するには、「既定のテキストエディターを設定する」セクションを参照してください。
モデルの検証要件を満たすように JSON テンプレートを変更します。
```
{
  "id": 2,
  "name": "Cherry"
}
```
.tmp ファイルを保存して、テキストエディターを閉じます。コマンドシェルに次の出力が表示されます。
```
[main 2019-06-28T17:27:01.805Z] update#setState idle
HTTP/1.1 204 No Content
Date: Fri, 28 Jun 2019 17:28:21 GMT
Server: Kestrel
```

省略可能: 変更を確認するには、get コマンドを実行します。たとえば、テキストエディターに「Cherry」と入力すると、get によって、次の出力が返されます。

https://localhost:5001/fruits> get
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sat, 22 Jun 2019 00:08:20 GMT
Server: Kestrel
Transfer-Encoding: chunked

[
  {
    "id": 1,
    "data": "Apple"
  },
  {
    "id": 2,
    "data": "Cherry"
  },
  {
    "id": 3,
    "data": "Strawberry"
  }
]


https://localhost:5001/fruits>

HTTP DELETE 要求をテストする

構文

delete <PARAMETER> [-F|--no-formatting] [-h|--header] [--response] [--response:body] [--response:headers] [-s|--streaming]

引数

PARAMETER

関連付けられたコントローラーアクションメソッドで求められるルートパラメーター (存在する場合)。

[オプション]

-F|--no-formatting

存在することで HTTP 応答の書式設定を抑制するフラグ。
-h|--header

HTTP 要求ヘッダーを設定します。次の 2 つの値の形式がサポートされています。
- {header}={value}
- {header}:{value}
--response:body

HTTP 応答の本文を書き込むファイルを指定します。たとえば、「 --response:body "C:\response.json" 」のように入力します。ファイルが存在しない場合は作成されます。
--response:headers

HTTP 応答のヘッダーを書き込むファイルを指定します。たとえば、「 --response:headers "C:\response.txt" 」のように入力します。ファイルが存在しない場合は作成されます。
-s|--streaming

存在することで HTTP 応答のストリーミングを有効にするフラグ。

例

HTTP DELETE 要求を発行するには、次のようにします。

省略可能: 変更前にデータを表示するには、get コマンドを実行します。

https://localhost:5001/fruits> get
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sat, 22 Jun 2019 00:07:32 GMT
Server: Kestrel
Transfer-Encoding: chunked

[
  {
    "id": 1,
    "data": "Apple"
  },
  {
    "id": 2,
    "data": "Orange"
  },
  {
    "id": 3,
    "data": "Strawberry"
  }
]

それをサポートしているエンドポイントで delete コマンドを実行します。
```
https://localhost:5001/fruits> delete 2
```
上記のコマンドでは、次の出力形式が表示されます。
```
HTTP/1.1 204 No Content
Date: Fri, 28 Jun 2019 17:36:42 GMT
Server: Kestrel
```

省略可能: 変更を確認するには、get コマンドを実行します。この例では、get によって次の出力が返されます。

https://localhost:5001/fruits> get
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sat, 22 Jun 2019 00:16:30 GMT
Server: Kestrel
Transfer-Encoding: chunked

[
  {
    "id": 1,
    "data": "Apple"
  },
  {
    "id": 3,
    "data": "Strawberry"
  }
]


https://localhost:5001/fruits>

HTTP PATCH 要求をテストする

構文

patch <PARAMETER> [-c|--content] [-f|--file] [-h|--header] [--no-body] [-F|--no-formatting] [--response] [--response:body] [--response:headers] [-s|--streaming]

引数

PARAMETER

関連付けられたコントローラーアクションメソッドで求められるルートパラメーター (存在する場合)。

[オプション]

-F|--no-formatting

存在することで HTTP 応答の書式設定を抑制するフラグ。
-h|--header

HTTP 要求ヘッダーを設定します。次の 2 つの値の形式がサポートされています。
- {header}={value}
- {header}:{value}
--response:body

HTTP 応答の本文を書き込むファイルを指定します。たとえば、「 --response:body "C:\response.json" 」のように入力します。ファイルが存在しない場合は作成されます。
--response:headers

HTTP 応答のヘッダーを書き込むファイルを指定します。たとえば、「 --response:headers "C:\response.txt" 」のように入力します。ファイルが存在しない場合は作成されます。
-s|--streaming

存在することで HTTP 応答のストリーミングを有効にするフラグ。

-c|--content

インライン HTTP 要求本文を提供します。たとえば、「 -c "{\"id\":2,\"name\":\"Cherry\"}" 」のように入力します。
-f|--file

HTTP 要求本文を含むファイルへのパスを提供します。たとえば、「 -f "C:\request.json" 」のように入力します。
--no-body

HTTP 要求本文が不要であることを示します。

HTTP HEAD 要求をテストする

構文

head <PARAMETER> [-F|--no-formatting] [-h|--header] [--response] [--response:body] [--response:headers] [-s|--streaming]

引数

PARAMETER

関連付けられたコントローラーアクションメソッドで求められるルートパラメーター (存在する場合)。

[オプション]

-F|--no-formatting

存在することで HTTP 応答の書式設定を抑制するフラグ。
-h|--header

HTTP 要求ヘッダーを設定します。次の 2 つの値の形式がサポートされています。
- {header}={value}
- {header}:{value}
--response:body

HTTP 応答の本文を書き込むファイルを指定します。たとえば、「 --response:body "C:\response.json" 」のように入力します。ファイルが存在しない場合は作成されます。
--response:headers

HTTP 応答のヘッダーを書き込むファイルを指定します。たとえば、「 --response:headers "C:\response.txt" 」のように入力します。ファイルが存在しない場合は作成されます。
-s|--streaming

存在することで HTTP 応答のストリーミングを有効にするフラグ。

HTTP OPTIONS 要求をテストする

構文

options <PARAMETER> [-F|--no-formatting] [-h|--header] [--response] [--response:body] [--response:headers] [-s|--streaming]

引数

PARAMETER

関連付けられたコントローラーアクションメソッドで求められるルートパラメーター (存在する場合)。

[オプション]

-F|--no-formatting

存在することで HTTP 応答の書式設定を抑制するフラグ。
-h|--header

HTTP 要求ヘッダーを設定します。次の 2 つの値の形式がサポートされています。
- {header}={value}
- {header}:{value}
--response:body

HTTP 応答の本文を書き込むファイルを指定します。たとえば、「 --response:body "C:\response.json" 」のように入力します。ファイルが存在しない場合は作成されます。
--response:headers

HTTP 応答のヘッダーを書き込むファイルを指定します。たとえば、「 --response:headers "C:\response.txt" 」のように入力します。ファイルが存在しない場合は作成されます。
-s|--streaming

存在することで HTTP 応答のストリーミングを有効にするフラグ。

HTTP 要求ヘッダーを設定する

HTTP 要求ヘッダーを設定するには、次のいずれかの方法を使用します。

HTTP 要求でインラインを設定します。次に例を示します。
```
https://localhost:5001/people> post -h Content-Type=application/json
```
上記の方法では、個別の HTTP 要求ヘッダーごとに独自の -h オプションが必要です。
HTTP 要求を送信する前に設定します。次に例を示します。
```
https://localhost:5001/people> set header Content-Type application/json
```
要求を送信する前にヘッダーを設定すると、コマンドシェルセッションの間はヘッダーが設定されたままになります。ヘッダーをクリアするには、空の値を指定します。次に例を示します。
```
https://localhost:5001/people> set header Content-Type
```

セキュリティで保護されたエンドポイントをテストする

HttpRepl は、次の方法で、セキュリティ保護されたエンドポイントのテストをサポートします。

ログインしているユーザーの既定の資格情報を使用する。
HTTP 要求ヘッダーを使用する。

既定の資格情報

IIS でホストされ、Windows 認証でセキュリティ保護されているテスト対象の Web API を考えてみます。ツールを実行するユーザーの資格情報が、テスト対象の HTTP エンドポイント全体に送信されるようにしたいと考えます。ログインしているユーザーの既定の資格情報を渡すには:

httpClient.useDefaultCredentials 設定を true に設定します。
```
pref set httpClient.useDefaultCredentials true
```
Web API に別の要求を送信する前に、ツールを終了して再起動します。

既定のプロキシ資格情報

テスト対象の Web API が Windows 認証でセキュリティ保護されたプロキシの背後にあるシナリオについて考えてみます。ツールを実行しているユーザーの資格情報をプロキシに送信したいと考えます。ログインしているユーザーの既定の資格情報を渡すには:

httpClient.proxy.useDefaultCredentials 設定を true に設定します。
```
pref set httpClient.proxy.useDefaultCredentials true
```
Web API に別の要求を送信する前に、ツールを終了して再起動します。

HTTP 要求ヘッダー

サポートされている認証および認可スキームの例には次のものがあります。

basic authentication
JWT ベアラートークン
ダイジェスト認証

たとえば、次のコマンドを使用して、ベアラートークンをエンドポイントに送信できます。

set header Authorization "bearer <TOKEN VALUE>"

Azure でホストされたエンドポイントにアクセスしたり、Azure REST API を使用したりするには、ベアラートークンが必要です。 Azure CLI で自分の Azure サブスクリプションのベアラートークンを取得するには、次の手順を使用します。 HttpRepl によって、HTTP 要求ヘッダーにベアラートークンが設定されます。 Azure App Service Web Apps の一覧が取得されます。

Azure にサインインします。
```
az login
```
次のコマンドで、サブスクリプション ID を取得します。
```
az account show --query id
```
サブスクリプション ID をコピーし、次のコマンドを実行します。
```
az account set --subscription "<SUBSCRIPTION ID>"
```
次のコマンドで、ベアラートークンを取得します。
```
az account get-access-token --query accessToken
```
HttpRepl を使用して、Azure REST API に接続します。
```
httprepl https://management.azure.com
```

Authorization HTTP 要求ヘッダーを設定します。

https://management.azure.com/> set header Authorization "bearer <ACCESS TOKEN>"

サブスクリプションに移動します。

https://management.azure.com/> cd subscriptions/<SUBSCRIPTION ID>

サブスクリプションの Azure App Service Web Apps のリストを取得します。

https://management.azure.com/subscriptions/{SUBSCRIPTION ID}> get providers/Microsoft.Web/sites?api-version=2016-08-01

次の応答が示されます。

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 35948
Content-Type: application/json; charset=utf-8
Date: Thu, 19 Sep 2019 23:04:03 GMT
Expires: -1
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: <em>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</em>
x-ms-original-request-ids: <em>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</em>
x-ms-ratelimit-remaining-subscription-reads: 11999
x-ms-request-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
x-ms-routing-request-id: WESTUS:xxxxxxxxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx
{
  "value": [
    <AZURE RESOURCES LIST>
  ]
}

HTTP 要求の表示を切り替える

既定では、送信中の HTTP 要求の表示は抑制されます。コマンドシェルセッションの期間中は、対応する設定を変更できます。

要求の表示を有効にする

echo on コマンドを実行して、送信中の HTTP 要求を表示します。次に例を示します。

https://localhost:5001/people> echo on
Request echoing is on

現在のセッションの後続の HTTP 要求では、要求ヘッダーが表示されます。次に例を示します。

https://localhost:5001/people> post

[main 2019-06-28T18:50:11.930Z] update#setState idle
Request to https://localhost:5001...

POST /people HTTP/1.1
Content-Length: 41
Content-Type: application/json
User-Agent: HTTP-REPL

{
  "id": 0,
  "name": "Scott Addie"
}

Response from https://localhost:5001...

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Date: Fri, 28 Jun 2019 18:50:21 GMT
Location: https://localhost:5001/people/4
Server: Kestrel
Transfer-Encoding: chunked

{
  "id": 4,
  "name": "Scott Addie"
}


https://localhost:5001/people>

要求の表示を無効にする

echo off コマンドを実行して、送信中の HTTP 要求の表示を抑制します。次に例を示します。

https://localhost:5001/people> echo off
Request echoing is off

[スクリプトの実行]

HttpRepl コマンドの同じセットを頻繁に実行する場合は、それらをテキストファイルに格納することを検討してください。ファイル内のコマンドは、コマンドラインで手動で実行されるコマンドと同じ形式になります。これらのコマンドは、run コマンドを使用してバッチ方式で実行できます。次に例を示します。

改行で区切られた一連のコマンドを含むテキストファイルを作成します。例として、次のコマンドを含む people-script.txt ファイルについて考えてみましょう。
```
set base https://localhost:5001
ls
cd People
ls
get 1
```

run コマンドを実行し、テキストファイルのパスを渡します。次に例を示します。

https://localhost:5001/> run C:\http-repl-scripts\people-script.txt

次のような出力が表示されます。

https://localhost:5001/> set base https://localhost:5001
Using OpenAPI description at https://localhost:5001/swagger/v1/swagger.json

https://localhost:5001/> ls
.        []
Fruits   [get|post]
People   [get|post]

https://localhost:5001/> cd People
/People    [get|post]

https://localhost:5001/People> ls
.      [get|post]
..     []
{id}   [get|put|delete]

https://localhost:5001/People> get 1
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 12 Jul 2019 19:20:10 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
  "id": 1,
  "name": "Scott Hunter"
}


https://localhost:5001/People>

出力を消去する

HttpRepl ツールによってコマンドシェルに書き込まれたすべての出力を削除するには、clear または cls コマンドを実行します。例として、コマンドシェルに次の出力が含まれているとします。

httprepl https://localhost:5001
(Disconnected)> set base "https://localhost:5001"
Using OpenAPI description at https://localhost:5001/swagger/v1/swagger.json

https://localhost:5001/> ls
.        []
Fruits   [get|post]
People   [get|post]

https://localhost:5001/>

次のコマンドを実行して、出力を消去します。

https://localhost:5001/> clear

上記のコマンドを実行すると、コマンドシェルには次の出力のみが含まれます。

https://localhost:5001/>

次の方法で共有

HttpRepl を使用して Web API をテストする

前提条件

インストール

使用法

Web API に接続する

Web API の OpenAPI の説明を手動でポイントする

OpenAPI の説明の検索、解析、検証に関する詳細の詳細出力を有効にする

Web API 内を移動する

使用可能なエンドポイントを表示する

エンドポイントに移動する

HttpRepl をカスタマイズする

設定を表示する

色の設定を設定する

インデントのサイズを設定する

既定のテキスト エディターを設定する

OpenAPI の説明の検索パスを設定する

HTTP GET 要求をテストする

構文

引数

[オプション]

例

HTTP POST 要求をテストする

構文

引数

[オプション]

例

HTTP PUT 要求をテストする

構文

引数

[オプション]

例

HTTP DELETE 要求をテストする

構文

引数

[オプション]

例

HTTP PATCH 要求をテストする

構文

引数

[オプション]

HTTP HEAD 要求をテストする

構文

引数

[オプション]

HTTP OPTIONS 要求をテストする

構文

引数

[オプション]

HTTP 要求ヘッダーを設定する

セキュリティで保護されたエンドポイントをテストする

既定の資格情報

既定のプロキシ資格情報

HTTP 要求ヘッダー

HTTP 要求の表示を切り替える

要求の表示を有効にする

要求の表示を無効にする

[スクリプトの実行]

出力を消去する

その他のリソース

その他のリソース

既定のテキストエディターを設定する