Minimal API add complex parameters into swagger UI

Question

After defining the endpoint

app.MapGet($"{baseRoute}/GetProducts", GetProductsAsync)
.WithName("GetProducts")
.Produces<ProductResponseDto>()
.WithTags(Tag);

With this async method to call implementation.

private static async Task<IResult> GetProductsAsync(ProductsDto getProducts, IUserService userService)
{
    ProductResponseDto getProductsResponse = await userService.GetProductsAsync(getProducts);
    return Results.Ok(getProductsResponse);
}

I defined a basic BindAsync method for bind values. I just want to add all fields contained in ProductsDto into swagger UI. Is it possible? If I use [FromQuery] annotation the Dto is null for every call. I am using .net core 6.

public class ProductsDto
{
    /// <summary>
    /// clientId
    /// </summary>
    public int clientId { get; set; }
    /// <summary>
    /// Test
    /// </summary>
    public int test { get; set; }

    public static ValueTask<ProductsDto> BindAsync(HttpContext context, ParameterInfo parameter)
    {
        int.TryParse(context.Request.Query["clientId"], out var in_clientId);
        int.TryParse(context.Request.Query["test"], out var in_test);
        var result = new ProductsDto
        {
            clientId = in_clientId,
            test = in_test
        };
        return ValueTask.FromResult<ProductsDto?>(result);
    }
}

Please add all relevant part including ProductsDto and desired url to be hit. — Guru Stron
– Guru Stron, Commented Mar 29, 2023 at 14:46

Tiny Wang · Accepted Answer · 2023-03-30 08:13:27Z

1

Is this what you want? Using [AsParameters]. Related document here.

In .net 6, we can use custom model binding...

app.MapGet("/GetProducts2", (ProductsDto getProducts) =>
{
    return Results.Ok();
});

public class ProductsDto
{
    public int clientId { get; set; }
    public int test { get; set; }

    public static bool TryParse(string? value, IFormatProvider? provider, out ProductsDto? prod)
    {
        var segments = value?.Split(',',
                StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
        if (segments?.Length == 2
            && int.TryParse(segments[0], out var x)
            && int.TryParse(segments[1], out var y))
        {
            prod = new ProductsDto { clientId = x, test = y };
            return true;
        }

        prod = null;
        return false;
    }
}

This will make the ProductsDto recognized as a string, and we can have TryParse method to handle the string and bind to the properties.

By the way, we can't use [FromQuery]ProductsDto getProducts. This will make the swagger UI show parameter like this which recognize ProductsDto as a object:

edited Mar 30, 2023 at 8:13

answered Mar 30, 2023 at 5:36

Tiny Wang

16.7k2 gold badges23 silver badges38 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

GerardoLisi Over a year ago

Unfortunately I have to use .net core 6 which does not support [AsParameters].

Tiny Wang Over a year ago

then we need custom binding with TryParse

Tiny Wang Over a year ago

I updated my post with a workaround in .net 6

Misiu Over a year ago

Any ideas on how to get the same results when using BindAsync?

Collectives™ on Stack Overflow

Minimal API add complex parameters into swagger UI

1 Answer 1

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related