【ASP.NET Core Web】パスパラメーターを取得する

.NET 8のASP.NET Core Webでパスパラメーター取得したい！

概要

今回の記事では、.NET 8のASP.NET Core Webでパスパラメーターを取得する手順を掲載する。

パスパラメーターは、例えばAPIサーバーからGETでデータを取得する時にURLに組み込む形で指定するパラメーターの種類。

exsample.com/api/users/123456

上記でいうと123456の部分がパスパラメーターになる。

仕様書

環境

.NET 8.0

手順書

パスパラメーターを取得するには、属性HttpGetや属性Routeを使ってパラメーターとなる部分の場所と名前を設定する。

コントローラーにパスパラメーターを設定する例。

namespace GetPathParameter.Controllers
{
    public class UserController : Controller
    {
        [HttpGet("api/users/{userId}")]
        public ActionResult<string> Get(string userId)
        {
            // ユーザーIDからユーザーの名前を返すみたいな！
            return GetUserName(userId);
        }

        ...
    }
}

例えば下記のような感じでGETすると

exsample.com/api/users/123456

引数userIdに123456が文字列で格納される。