Visual Studio を使用して Azure API Management に ASP.NET Core Web API を発行する

2025-01-19

このチュートリアルでは、Visual Studio を使用して ASP.NET Core Web API プロジェクトを作成し、OpenAPI がサポートされていることを確認してから、Azure App Service と Azure API Management の両方に Web API を発行する方法について説明します。

設定

チュートリアルを完了するには、Azure アカウントが必要です。

無料の Azure アカウントがない場合は、を開きます。

ASP.NET Core Web API を作成する

Visual Studio を使用すると、テンプレートから新しい ASP.NET Core Web API プロジェクトを簡単に作成できます。次の手順に従って、新しい ASP.NET Core Web API プロジェクトを作成します。

ファイルメニューから、新しいプロジェクトを選択します。
検索ボックスに Web API を入力します。
ASP.NET Core Web API テンプレートを選択し、[次へ]を選択します。
[新しいプロジェクトの構成] ダイアログで、プロジェクトに WeatherAPI という名前を付けて、[次へ] を選択します。
[追加情報 ダイアログで、次の手順を実行します。
フレームワークが .NET 6.0 (長期サポート)されていることを確認します。
[コントローラーを使用する (最小限の API を使用する場合はオフにします)] チェックボックスがオンになっていることを確認します。
[OpenAPI サポートを有効にするのチェックボックスがオンになっていることを確認します。
[作成] を選択します。

コードを調べる

Swagger 定義を使用すると、Azure API Management でアプリの API 定義を読み取ります。アプリの作成時に [OpenAPI サポート を有効にする] チェックボックスをオンにすると、Visual Studio によって Swagger 定義を作成するコードが自動的に追加されます。次のコードを示す Program.cs ファイルを開きます。


...

builder.Services.AddSwaggerGen();

...

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(); // Protected by if (env.IsDevelopment())
}

...

Swagger 定義が常に生成されていることを確認する

Azure API Management では、アプリケーションの環境に関係なく、Swagger 定義が常に存在する必要があります。常に生成されるように、app.UseSwagger(); を if (app.Environment.IsDevelopment()) ブロックの外側に移動します。

更新されたコード:


...

app.UseSwagger();

if (app.Environment.IsDevelopment())
{
    app.UseSwaggerUI();
}

...

API ルーティングを変更する

WeatherForecastControllerの Get アクションにアクセスするために必要な URL 構造を変更します。次の手順を実行します。

WeatherForecastController.cs ファイルを開きます。
[Route("[controller]")] クラスレベルの属性を [Route("/")]に置き換えます。更新されたクラス定義:
```
[ApiController]
[Route("/")]
public class WeatherForecastController : ControllerBase
```

Web API を Azure App Service に発行する

ASP.NET Core Web API を Azure API Management に発行するには、次の手順を実行します。

API アプリを Azure App Service に発行します。
ASP.NET Core Web API アプリを Azure API Management サービスインスタンスに発行します。

API アプリを Azure App Service に発行する

ASP.NET Core Web API を Azure API Management に発行するには、次の手順を実行します。

ソリューションエクスプローラーで、プロジェクトを右クリックし、 [発行] を選択します。
[発行] ダイアログで、[Azure] を選択し、[次へ] ボタンを選択します。
Azure App Service (Windows) 選択し、[次へ] ボタンを選択します。
[新しい Azure App Serviceの作成] を選択します。

「App Service の作成」ダイアログが表示されます。 アプリ名、リソースグループ、および アプリサービスプラン のエントリフィールドが入力されています。これらの名前は保持することも、変更することもできます。
[作成] ボタンを選択します。
アプリサービスが作成されたら、[次] ボタンを選択します。
新しい API Management サービスの作成を選択します。

API Management Service の作成ダイアログが表示されます。 API 名、サブスクリプション名、および リソースグループ のエントリフィールドは、そのままにしておくことができます。 API Management Service エントリの横にある 新しい ボタンを選択し、そのダイアログボックスの必須フィールドを入力します。

[OK] ボタンを選択して、API Management サービスを作成します。
[作成] ボタンを選択して、API Management サービスの作成に進みます。この手順の完了には数分かかる場合があります。
完了したら、[完了] ボタンを選択します。
ダイアログが閉じ、概要画面に発行に関する情報が表示されます。 [発行] ボタンを選びます。

Web API は、Azure App Service と Azure API Management の両方に発行されます。新しいブラウザーウィンドウが表示され、Azure App Service で実行されている API が表示されます。そのウィンドウを閉じることができます。
Web ブラウザーで Azure portal を開き、作成した API Management インスタンスに移動します。
左側のメニューから API オプションを選択します。
前の手順で作成した API を選択します。内容が設定されているので、調べることができます。

発行された API 名を構成する

現在、API の名前は WeatherAPIとなっていることに注意してください。しかし、我々はそれを 天気予報と呼びたいと思います。名前を更新するには、次の手順を実行します。

services.AddSwaggerGen(); の直後に次のコードを Program.cs に追加します

builder.Services.ConfigureSwaggerGen(setup =>
{
    setup.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
    {
        Title = "Weather Forecasts",
        Version = "v1"
    });
});

ASP.NET Core Web API を再発行し、Azure portal で Azure API Management インスタンスを開きます。
ブラウザーでページを更新します。これで、API の名前が正しく表示されます。

Web API が動作していることを確認する

Azure API Management でデプロイされた ASP.NET Core Web API は、Azure portal から次の手順でテストできます。

[テスト] タブを開きます。
/ または Get 操作を選択します。
[Send] を選択します。

クリーンアップ

アプリのテストが完了したら、Azure portal に移動し、アプリを削除します。

リソースグループ選択し、作成したリソースグループを選択します。
リソースグループ ページで、削除を選択します。
リソースグループの名前を入力し、[の削除] 選択します。これで、このチュートリアルで作成したアプリとその他のすべてのリソースが Azure から削除されます。