このシリーズの記事をわかりやすく説明するために、ビジネスシナリオを紹介します。それはシンプルな試験システムです(記事のデモ例としてのみ)。ER図は下記の通りです。1. システムには問題集があり、問題には答えがあり、問題のタイプとカテゴリーに分かれています;2. システムには受験者ユーザーがおり、問題集から試験を組織して受験者に割り当て、受験者は試験を受けて結果を記録できます。
app.MapGet("/", () => "Hello .NET Mini API!");
Mini APIの最大の利点は、そのシンプルさと使いやすさです。例えば、上記のコード行では、MapGetの引数が2つあります。最初の引数はルーティング情報、二番目の引数は実装方法です。「このチャネルが何をするか」(最初の引数はこのチャネル、二番目の引数はそれが何をするか)という意味です。ここで、2番目の引数は実際にはラムダ式で、メソッド(関数)に置き換えることもできます。このメソッドは静的なものでもインスタンスメソッドでもかまいません。主に何をするかを完了できればよいのです。
さらに詳細に見ていきましょう。2つの引数についてです:
最初の引数:
app.MapGet("/question/{id:int}", (int id) => $"ID{id}の問題を検索");
この時、リクエストURLは:/question/1ですが、ここでは整数型に限定されているため、文字列や小数を使用すると404エラーになります。URLを/question/-1に変更しても通りますが、次のようになります:
しかし、データベースには-1のようなIDは存在しません(データは1から始まり、増分値は1です)。したがって、ルーティングのルールを強化する必要があります:
app.MapGet("/question/{id:min(1)}", (int id) => $"ID{id}の問題を検索");
これにより、負の数だけでなく0も排除されます。uintを使うとどうなるでしょうか?
app.MapGet("/question/{id:uint}", (uint id) => $"ID{id}の問題を検索");
エラーは、コンテナからuintを見つけることができないために発生します。これは、公式のルーティングパラメーターの制約にuintの処理が含まれていないためです。では、符号なし整数をパラメーターとして使用したい場合はどうすればよいでしょうか?その場合は、カスタムルーティングの制約を定義しましょう。
var builder = WebApplication.CreateBuilder();
builder.Services.AddRouting(options =>
{
options.ConstraintMap["Uint"] = typeof(MyRouteConstraint.Uint);
});
var app = builder.Build();
//パラメーター・ルーティング
app.MapGet("/question/{id:Uint}", (uint id) => $"ID{id}の問題を検索");
app.Run();
namespace MyRouteConstraint
{
public class Uint : IRouteConstraint
{
public bool Match(HttpContext? httpContext, IRouter? route, string routeKey,RouteValueDictionary values, RouteDirection routeDirection)
{
if (values == null || values.Count == 0 || string.IsNullOrWhiteSpace(routeKey))
{
return false;
}
var result = uint.TryParse(values[routeKey].ToString(), out uint value);
if (result)
{
return true;
}
return false;
}
}
}
ルーティングの制約には正規表現もサポートされています。詳細は以下のコードを参照してください:
app.MapGet("/area/{postcode:regex(^[0-9]{3}-[0-9]{4}$)}", (string postcode) => $"郵便番号:{postcode}");
二番目の引数:
- クエリパラメーターからデータを取得する:
app.MapGet("/answer", ([FromQuery(Name="id")]int answerId) => $"[FromQuery]-リクエストされたAnswerIDは{answerId}");
app.MapGet("/answers", ([FromHeader(Name = "key")] string secretkey ) => $"[FromHeader]-secretkeyは{secretkey}");
app.MapGet("/question/{questiontype}", ([FromRoute]string questionType) => $"[FromRoute]-questiontype={questionType}");
app.MapPost("/answer", ([FromBody] Answer answer) => $"[FromBody]-answer:{System.Text.Json.JsonSerializer.Serialize(answer)}");
5. フォームからデータを取得する(エラー、.net6はAPIのためサポートしていない)
app.MapPost("/questiontype", ([FromForm] string questionTypeName) => $"[FromForm]-questionTypeName:{questionTypeName}");
6. サービスコンテナからデータを取得する、後で説明する
上記のFromは、リクエストの異なる領域から明示的にデータを取得するものです。ここで質問があります、From属性を削除して、各インターフェースの訪問が正常に行えるかどうかを確認してみてください[画像]。なぜでしょうか?
カスタムパラメーターバインディング
二番目の引数がメソッドであり、そのメソッドのパラメータが複雑な場合はどうすればよいでしょうか?公式は2つのカスタムパラメーターバインディング方法を提供しています。以下のデモを見てください。たとえば、特定のエリアのすべてのホテルを検索したい場合、パラメータは座標グループで、その後でバックエンドでこの範囲内のホテルを検索できるようになります。複雑なタイプを受け付ける必要がありますが、Request.Queryで受け取るのは文字列なので、これら2つのカスタムバインディングが変換作業を担当します(注:もちろん、JsonのBodyをPostする方法もあります)
using System.Reflection;
var app = WebApplication.Create();
//カスタムパラメーターのバインディング area=[(35.721875, 139.786564),(35.723903, 139.803464),(35.705806, 139.806078),(35.705118, 139.779927)]
app.MapGet("/area1/hotel", (Area1 area) => $"TryParse Area1:{System.Text.Json.JsonSerializer.Serialize(area)}");
app.MapGet("/area2/hotel", (Area2 area) => $"BindAsync Area2:{System.Text.Json.JsonSerializer.Serialize(area)}");
app.Run();
public class Area1
{
public Coordinates[]? Coordinateses { get; set; }
public static bool TryParse(string? value, IFormatProvider? provider, out Area1? area)
{
var CoordinatesGroupStrings = value?.Split(new string[] { "[(", ")]", "),(" }, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
if (CoordinatesGroupStrings != null)
{
var coordinatesList = new List<Coordinates>();
foreach (var coordinateGroupString in CoordinatesGroupStrings)
{
var coordinateStrings = coordinateGroupString.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
var latitudeResult = double.TryParse(coordinateStrings[0], out double latitude);
var longitudeResult = double.TryParse(coordinateStrings[1], out double longitude);
if (latitudeResult && longitudeResult)
{
coordinatesList.Add(new Coordinates(latitude, longitude));
}
}
area = new Area1 { Coordinateses = coordinatesList.ToArray() };
return true;
}
area = null;
return false;
}
}
public record Coordinates(double Latitude, double Longitude);
public class Area2
{
public Coordinates[]? Coordinateses { get; set; }
public static ValueTask<Area2?> BindAsync(HttpContext context, ParameterInfo parameter)
{
var CoordinatesGroupStrings = context.Request.Query["area"].ToString().Split(new string[] { "[(", ")]", "),(" }, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
if (CoordinatesGroupStrings != null)
{
var coordinatesList = new List<Coordinates>(); foreach (var coordinateGroupString in CoordinatesGroupStrings)
{
var coordinateStrings = coordinateGroupString.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
var latitudeResult = double.TryParse(coordinateStrings[0], out double latitude); var longitudeResult = double.TryParse(coordinateStrings[1], out double longitude);
if (latitudeResult && longitudeResult)
{
coordinatesList.Add(new Coordinates(latitude, longitude));
}
}
return ValueTask.FromResult<Area2?>(new Area2 { Coordinateses = coordinatesList.ToArray() });
}
return ValueTask.FromResult<Area2?>(null);
}
}
(Translated by GPT)