.NET 6 の ASP.NET Core Web API 新規プロジェクトでベースパスを指定したら HTTP 404

ルートではなくその下のパスに Web アプリを配置

.NET の Web アプリケーションフレームワーク ASP.NET Core プログラミングでの話。

イントラネット向けの ASP.NET Core Web アプリの場合、配置先のサーバー 1 台に複数の Web アプリを同居配置しているケースがある。Virtual Host でも実現できるが、異なるベースパスに配置することも、よく見聞きする。

つまり「https://example.com/app1」と「https://example.com/app2」という異なるベースパスにそれぞれ別々の ASP.NET Core Web アプリを配置する、というパターンだ。

コンシューマ向け・インターネット公開の案件だと、このような配置方法はあまりお目にかからない気がするが、イントラネットだと珍しくない印象で、それこそ .NET Framework の時代からまま採用してきた経験がある。

このベースパスの指定、.NET Core 世代だと、プログラムコード上で明示的に指定する必要がある。

具体的には、アプリケーション起動時の要求処理パイプラインの組み立てのところで、「UsePathBase()」拡張メソッドを呼び出すことで指定する。ベースパスを「app1」とするなら、下記のようなコードを実装すればよい。

app.UsePathBase("/app1");

「UsePathBase()」を使って ASP.NET Core Web アプリのベースパスを指定する方法については、マイクロソフトの公式ドキュメントサイトに説明がある (下記リンク先)。

.NET 6 で同じようにやってみたら、HTTP 404 !?

さてそのようなベースパスを指定しての ASP.NET Core Web アプリ開発、"イントラネットだと珍しくない" とは言いつつここ暫く手がけたことはなかったところ、久方ぶりに扱うことになった。

さて本ブログ記事投稿時点での .NET 最新 LTS バージョンは .NET 6 ということで、.NET 6 SDK を使って、新規に ASP.NET Core Web アプリを作ることにする。今回は Web API 案件だったので、dotnet CLI だと以下のコマンドで新規プロジェクト作成した。

dotnet new webapi

そうしてできた新規プロジェクトは、.NET 6 からの新スタイル、Minimal API 形式のプログラムだ。引き続き早速、「UsePathBase()」拡張メソッド呼び出しを追加する。例えば配置先ベースパスが "foo/bar" だとすると、下記のようになる。

var builder = WebApplication.CreateBuilder(args);

...

var app = builder.Build();

app.UsePathBase("/foo/bar");

app.MapGet("/hello", ()=> "Hello");

...

以上の実装で、ブラウザで「http://.../foo/bar/helo」を開いたら、"Hello" の文字列が返ってくるのが確認できるはずだ。

早速「dotnet run」で実行し、ブラウザで開いてみると...

なんと、まさかの HTTP ERROR 404 Not Found が返ってきてしまった。

.NET 5 までだとこんな現象にお目にかかったことがないのだが、はてさて。

ドキュメントをよく読もう!

どうにも困ったと首をひねりながら、もういちど公式ドキュメントに目を通してみる。

すると...ちゃんと注意書きがあるではないか! (以下引用)

注意
WebApplication を使用する場合 (ASP.NET Core 5.0 から 6.0 への移行に関する記事を参照) は、UsePathBase の後に app.UseRouting を呼び出して、ルーティング ミドルウェアがルートを照合する前に変更されたパスを確認できるようにする必要があります。 そうしない場合、ミドルウェアの順序とルーティングに関する記事で説明されているように、ルートはパスが書き直される前に UsePathBase によって照合されます。

どうやら、.NET 6 の 新規 Web API プロジェクト作成のテンプレートだと、「UseRouting()」の呼び出しが含まれておらず (Minimal API の動作的には不要)、それで「UsePathBase()」が効果を発揮しなかったらしい。

注意書き以外にも、"早い段階で UsePathBase を呼び出して..." と書いてあるあとのコード例中に、しれっと「UseRouting()」呼び出しが記載されていて (下図)、よく考えるとこれがヒントにはなっていたっぽい。

ということで「UseRouting()」の呼び出しを追加して、無事、ベースパスを指定しての実行が期待どおりに動作するようになった。

var builder = WebApplication.CreateBuilder(args);

...

var app = builder.Build();

app.UsePathBase("/foo/bar");

app.UseRouting(); // 👈 これを追加

app.MapGet("/hello", ()=> "Hello");

...

.NET 6 SDK が生成する Web API 新規プロジェクトのコードが、その前の .NET 5 までとまったく同じというわけではないので、.NET 5 までで手慣れた方法・知識だけだと躓くことがあった、という話。

公式ドキュメントはよく読もう!