how to return Results for net7 TypedResults.Text type?

Question

how to return Results for net7 TypedResults.Text type?

William Liu 556

Per the MSDN document saying, you can use the following code in net 7. It can help to generate different return type in swagger document according this blog saying.

Results<Ok, BadRequest> result = TypedResults.Ok();

My question is, if I have TypedResults.Text with different StatusCodes, which means it will return 200 or 400 result. How to specify the generic Results type for this return?
I tried the following code, but it just returns the BadRequest type in swagger without the 200 retrun type.

Results<ContentHttpResult, BadRequest> result = bResult  
    ? TypedResults.Text("Ok")  
    : TypedResults.Text("Bad", statusCode:StatusCodes.Status400BadRequest);

Rena Ni - MSFT 2,066 Reputation points

2022-11-16T07:02:25.63+00:00

Hi @William Liu , what is your bResult?
William Liu 556 Reputation points

2022-11-17T05:24:44.197+00:00

It`s just a boolean value received from other place. Then this code will response "Ok" or "Bad" depending on this boolean value.
Rena Ni - MSFT 2,066 Reputation points

2022-11-17T06:21:44.933+00:00

Hi @William Liu , yes, of course it is a Boolean value. If bResult is true it will get response "OK" with 200 status code, otherwise it will get response "bad" with 400 status code. Do you mean you want to display this two results in the sample of the Responses in swagger like the following picture from your shared blog?

William Liu 556

Yes, you`re correct. I would like to see both of the 200 and 400 response in swagger. Attached my test code and result screenshot. I can only find the 400 in swagger. Could you please let me know how to fix it? Thanks!

using Microsoft.AspNetCore.Http.HttpResults;  
using Microsoft.AspNetCore.Mvc;  
  
var builder = WebApplication.CreateBuilder(args);  
  
builder.Services.AddEndpointsApiExplorer();  
builder.Services.AddSwaggerGen();  
  
var app = builder.Build();  
  
app.UseSwagger();  
app.UseSwaggerUI();  
  
app.MapGet("/foo", Foo);  
  
app.Run();  
  
static Results<ContentHttpResult, BadRequest> Foo([FromQuery] bool condition)  
{  
    Results<ContentHttpResult, BadRequest> result = condition  
         ? TypedResults.Text("Ok", statusCode: StatusCodes.Status200OK)  
         : TypedResults.Text("Bad", statusCode: StatusCodes.Status400BadRequest);  
  
    return result;  
}

Accepted answer

0 additional answers

Your answer

Rena Ni - MSFT 2,066 Reputation points

2022-11-16T07:02:25.63+00:00

Hi @William Liu , what is your bResult?
William Liu 556 Reputation points

2022-11-17T05:24:44.197+00:00

It`s just a boolean value received from other place. Then this code will response "Ok" or "Bad" depending on this boolean value.
Rena Ni - MSFT 2,066 Reputation points

2022-11-17T06:21:44.933+00:00

Hi @William Liu , yes, of course it is a Boolean value. If bResult is true it will get response "OK" with 200 status code, otherwise it will get response "bad" with 400 status code. Do you mean you want to display this two results in the sample of the Responses in swagger like the following picture from your shared blog?
William Liu 556 Reputation points

2022-11-19T07:16:30.237+00:00

Yes, you`re correct. I would like to see both of the 200 and 400 response in swagger. Attached my test code and result screenshot. I can only find the 400 in swagger. Could you please let me know how to fix it? Thanks!

using Microsoft.AspNetCore.Http.HttpResults; using Microsoft.AspNetCore.Mvc; var builder = WebApplication.CreateBuilder(args); builder.Services.AddEndpointsApiExplorer(); builder.Services.AddSwaggerGen(); var app = builder.Build(); app.UseSwagger(); app.UseSwaggerUI(); app.MapGet("/foo", Foo); app.Run(); static Results<ContentHttpResult, BadRequest> Foo([FromQuery] bool condition) { Results<ContentHttpResult, BadRequest> result = condition ? TypedResults.Text("Ok", statusCode: StatusCodes.Status200OK) : TypedResults.Text("Bad", statusCode: StatusCodes.Status400BadRequest); return result; }

Answer 1

Hi @William Liu ,

You need change your code like below to achieve your requirement:

app.MapGet("/foo", Foo).Produces<ContentHttpResult>().Produces<BadRequest>();

If the answer is the right solution, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".
Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Best Regards,
Rena

Share via

how to return Results for net7 TypedResults.Text type?

0 additional answers

Your answer