Как вернуть HttpProblemDetails из минимального API ASP.NET Core 8 при использовании [AsParameters]?

Я пытаюсь создать конечную точку минимального API ASP.NET Core 8 и пытаюсь заставить ее возвращать HttpProblemDetails, когда параметры строки запроса недействительны. Конечно, я могу реализовать собственную проверку, но я пытаюсь использовать для этого фреймворк.

По сути, если у меня есть параметр строки запроса (например, целое число), а входные данные не являются допустимым целым числом, то я получаю обратно «неправильный запрос», но без какого-либо тела. Из-за этого потребителю сложно понять, что именно не так.

Вот воспроизведение модульного теста C# (я использую TestServer, но получаю тот же результат, когда использую пустельгу):

using System.Net.Http;
using System.Net;
using System.Reflection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.TestHost;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Shouldly;

namespace TestProject1
{
    public class HttpProblemDetailsTests
    {
        [Fact]
        public async Task Should_return_problem_details_if_querystring_not_provided()
        {
            var (host, testClient) = await SetupWebApp();

            var response = await testClient.GetAsync("/problem");
            response.StatusCode.ShouldBe(HttpStatusCode.BadRequest);
            var text = await response.Content.ReadAsStringAsync();
            
            // Fails on this line
            text.ShouldNotBeEmpty();

            await host.StopAsync();
        }
        
        [Fact]
        public async Task Returns_ok_if_querystring_provided()
        {
            var (host, testClient) = await SetupWebApp();

            var response = await testClient.GetAsync("/problem?abc=123");

            response.StatusCode.ShouldBe(HttpStatusCode.OK);
            await host.StopAsync();
        }

        private async Task<(IHost host, HttpClient testClient)> SetupWebApp()
        {
            var b = new HostBuilder()
                .ConfigureWebHost(c =>
                {
                    c.UseTestServer();
                    c.ConfigureServices(services =>
                    {
                        services.AddProblemDetails(); 
                        services.AddRouting();
                    });
                    c.Configure(app =>
                    {
                        app.UseExceptionHandler();

                        app.UseRouting();
                        app.UseEndpoints(endpoints =>
                        {
                            endpoints.MapGet("/problem", Problem);
                        });
                    });
                });

            var host = await b.StartAsync();

            var testClient = host.GetTestClient();
            testClient.DefaultRequestHeaders.Add("Accept", "application/json");
            return (host, testClient);
        }

        public class MyParameters
        {
            public int Abc { get; set; }
        }

        private async Task<IResult> Problem([AsParameters] MyParameters p)
        {
            return Results.Text("Hello, World!");
        }
    }
}

Я пробовал еще несколько вещей:

  1. Добавьте свою собственную реализацию IProblemDetailsWriter, но, похоже, она не подходит
  2. Используйте [FromQuery], а не [AsParameters]. Это дает тот же результат
  3. Я последовал примеру здесь, но это также дает тот же результат: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/minimal-apis/handle-errors?view=aspnetcore-8.0#problem-details

Вы можете настроить промежуточное программное обеспечение маршрутизации для выдачи ошибок при неправильном запросе. Это позволит вам обработать исключение и добавить тело.

beautifulcoder 22.08.2024 17:21

@beautifulcoder, как бы ты это сделал? Я не вижу никаких вариантов для этого ни в классе RouteOptions, ни в EndpointMiddleware.

Erwin van der Valk 23.08.2024 08:00
Стоит ли изучать PHP в 2023-2024 годах?
Стоит ли изучать PHP в 2023-2024 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
1
2
51
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Сначала вам нужно будет отправить неверный запрос:

var builder = WebApplication.CreateBuilder(args);
builder.Services.Configure<RouteHandlerOptions>(options =>
{
    options.ThrowOnBadRequest = true;
});

Затем, как только выдается исключение. У вас должна быть возможность подключить обработчик исключений с помощью промежуточного программного обеспечения.

app.UseExceptionHandler("/error");

app.Map("/error", (HttpContext context) =>
{
    var exception = context.Features.Get<IExceptionHandlerFeature>()?.Error;
    if (exception is BadHttpRequestException badRequestException)
    {
        return Results.BadRequest(new ErrorResponse
        {
            Error = "Invalid Parameter",
            Details = badRequestException.Message
        });
    }

    return Results.Problem("An unexpected error occurred.");
});

Идея состоит в том, чтобы уловить как можно больше деталей и вернуть ответ с телом.

Спасибо. В итоге я решил обработку ошибки следующим образом: ''' Services.AddProblemDetails(opt => opt.CustomizeProblemDetails = context => { if (context.Exception is BadHttpRequestException ex) { context.HttpContext.Response.StatusCode = 400; context.ProblemDetails.Detail = ex.Message context.ProblemDetails.Status = 400 } }); '''

Erwin van der Valk 26.08.2024 10:22

но «выброс неверных запросов» определенно был трюком. Должен быть более заметным в документации.

Erwin van der Valk 26.08.2024 10:23

Другие вопросы по теме