ASP.NET Core Web API プロジェクトの構成⚓︎

{
  "runtime": "Net80",
  "defaultVariables": null,
  "documentGenerator": {
    "aspNetCoreToOpenApi": {
      "project": "AaaSubSystem.Web.csproj", // プロジェクト名を指定
      "documentName": "v1",
      "msBuildProjectExtensionsPath": null,
      "configuration": "$(Configuration)",
      "runtime": null,
      "targetFramework": null,
      "noBuild": true,
      "msBuildOutputPath": null,
      "verbose": true,
      "workingDirectory": null,
      "aspNetCoreEnvironment": "Development",
      "output": "XXXXXXXXX-api.json", // 出力するファイル名を指定
      "newLineBehavior": "LF"
    }
  },
  "codeGenerators": {}
}

<Project Sdk="Microsoft.NET.Sdk.Web">
  <!-- 追加箇所以外は省略 -->
  <Target Name="NSwag" AfterTargets="PostBuildEvent" Condition="'$(Configuration)' == 'Debug'">
    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run nswag.json /variables:Configuration=$(Configuration)" />
  </Target>

  <PropertyGroup>
    <RunPostBuildEvent>OnBuildSuccess</RunPostBuildEvent>
  </PropertyGroup>
</Project>

builder.Services.AddOpenApiDocument(config =>
{
    config.PostProcess = document =>
    {
        document.Info.Version = "1.0.0";
        document.Info.Title = "Xxx Web API";
        document.Info.Description = "Xxx の Web API 仕様";
        document.Servers.Add(new()
        {
            Description = "ローカル開発用のサーバーです。",
            Url = "https://localhost:5001",
        });
    };
});

if (app.Environment.IsDevelopment())
{
    app.UseOpenApi();
    app.UseSwaggerUi();
}

using Microsoft.AspNetCore.Diagnostics;
using Microsoft.AspNetCore.Mvc;

namespace AaaSubSystem.Web.Controllers; // 名前空間は適宜変更してください。

/// <summary>
///  エラーの情報にアクセスする API コントローラーです。
///  このコントローラーは、例外ハンドラーで例外を検知したときに呼び出されることを想定しています。
/// </summary>
[ApiController]
[ApiExplorerSettings(IgnoreApi = true)] // OpenAPI 仕様書にこのコントローラーの情報を追加しないよう制御します。
public class ErrorController : ControllerBase
{

    /// <summary>
    ///  開発環境におけるエラー情報取得のためのルートパスのリテラル値 ( /error-development ) です。
    /// </summary>
    private const string DevelopmentErrorRouteLiteral = "/error-development";

    /// <summary>
    ///  実行環境におけるエラー情報取得のためのルートパスのリテラル値 ( /error ) です。
    /// </summary>
    private const string ErrorRouteLiteral = "/error";

    /// <summary>
    ///  開発環境におけるエラー情報取得のためのルートパス（ /error-development ）を取得します。
    /// </summary>
    public static string DevelopmentErrorRoute => DevelopmentErrorRouteLiteral; // 別プロジェクトから定数を参照するため、プロパティを経由します。

    /// <summary>
    ///  実行環境におけるエラー情報取得のためのルートパス ( /error )を取得します。
    /// </summary>
    public static string ErrorRoute => ErrorRouteLiteral; // 別プロジェクトから定数を参照するため、プロパティを経由します。

    /// <summary>
    ///  開発環境でのエラーレスポンスを取得します。
    /// </summary>
    /// <param name="hostEnvironment">環境の情報。</param>
    /// <returns>エラーの詳細情報。</returns>
    [Route(DevelopmentErrorRouteLiteral)]
    public IActionResult HandleErrorDevelopment([FromServices] IHostEnvironment hostEnvironment)
    {
        // 開発環境以外からのアクセスは HTTP 404 を返します。
        if (!hostEnvironment.IsDevelopment())
        {
            return this.NotFound();
        }

        var exceptionHandlerFeature = this.HttpContext.Features.Get<IExceptionHandlerFeature>();
        return this.Problem(
            detail: exceptionHandlerFeature?.Error.StackTrace,
            title: exceptionHandlerFeature?.Error.Message);
    }

    /// <summary>
    ///  実行環境でのエラーレスポンスを取得します。
    /// </summary>
    /// <returns>エラーの情報。</returns>
    [Route(ErrorRouteLiteral)]
    public IActionResult HandleError() => this.Problem();
}

if (app.Environment.IsDevelopment())
{
    app.UseExceptionHandler(ErrorController.DevelopmentErrorRoute);
}
else
{
    app.UseExceptionHandler(ErrorController.ErrorRoute);
}

builder.Services
    .AddControllers()
    .ConfigureApiBehaviorOptions(options =>
    {
        options.SuppressMapClientErrors = true;
    });

using Microsoft.AspNetCore.Mvc;

namespace AaaSubSystem.Web.Controllers;

[Route("api/sample")]
[ApiController]
[Produces("application/json")]
public class SampleController : ControllerBase
{
    [HttpGet]
    [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(UserResponse))]
    [ProducesResponseType(StatusCodes.Status500InternalServerError, Type = typeof(ProblemDetails))]
    public IActionResult GetSample()
    {
      // 省略
    }
}

builder.Services
    .AddControllers()
    .ConfigureApiBehaviorOptions(options =>
    {
        // Bad Request となった場合の処理。
        var builtInFactory = options.InvalidModelStateResponseFactory;
        options.InvalidModelStateResponseFactory = context =>
        {
            // エラーの原因をログに出力。
            var logger = context.HttpContext.RequestServices.GetRequiredService<ILogger<Program>>();
            logger.LogInformation("HTTP 要求に誤りがあります。詳細情報: {0} 。", JsonSerializer.Serialize(context.ModelState));

            // ASP.NET Core の既定の実装を使ってレスポンスを返却。
            return builtInFactory(context);
        };
    });

if (builder.Environment.IsDevelopment())
{
    builder.Services.AddHttpLogging(logging =>
    {
        // どのデータをどのくらいの量出力するか設定。
        // 適宜設定値は変更する。
        logging.LoggingFields = HttpLoggingFields.All;
        logging.RequestBodyLogLimit = 4096;
        logging.ResponseBodyLogLimit = 4096;
    });
}

if (app.Environment.IsDevelopment())
{
    // HTTP 通信ログを有効にする。
    app.UseHttpLogging();
}

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning",
      "AaaSubSystem": "Information"
    }
  }
}

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning",
      "Microsoft.AspNetCore.HttpLogging": "Information",
      "Microsoft.Extensions.Diagnostics.HealthChecks": "Debug",
      "AaaSubSystem": "Debug"
    }
  }
}