AppBuilder: When adding REST-api the endpoints are disabled and not selectable

Robert Deutschmann posted over 1 year ago

For a simple test project i created a REST-api with only some endpoints. But when adding this REST-api into AppBuilder the endpoints "Employees" are visible but not selectable - they are grey and looks disabled:

swagger-definition:

swagger_def.txt

{
openapi: "3.0.1",
info: {
title: "FullStack.API",
version: "1.0"
},
paths: {
/api/Employees: {
get: {
tags: [
"Employees"
],
responses: {
200: {
description: "Success"
}
}
},
post: {
tags: [
"Employees"
],
requestBody: {
content: {
application/json: {
schema: {
$ref: "#/components/schemas/Employee"
}
},
text/json: {
schema: {
$ref: "#/components/schemas/Employee"
}
},
application/*+json: {
schema: {
$ref: "#/components/schemas/Employee"
}
}
}
},
responses: {
200: {
description: "Success"
}
}
}
},
/api/Employees/{id}: {
get: {
tags: [
"Employees"
],
parameters: [
{
name: "id",
in: "path",
required: true,
schema: {
type: "string",
format: "uuid"
}
}
],
responses: {
200: {
description: "Success"
}
}
},
put: {
tags: [
"Employees"
],
parameters: [
{
name: "id",
in: "path",
required: true,
schema: {
type: "string",
format: "uuid"
}
}
],
requestBody: {
content: {
application/json: {
schema: {
$ref: "#/components/schemas/Employee"
}
},
text/json: {
schema: {
$ref: "#/components/schemas/Employee"
}
},
application/*+json: {
schema: {
$ref: "#/components/schemas/Employee"
}
}
}
},
responses: {
200: {
description: "Success"
}
}
},
delete: {
tags: [
"Employees"
],
parameters: [
{
name: "id",
in: "path",
required: true,
schema: {
type: "string",
format: "uuid"
}
}
],
responses: {
200: {
description: "Success"
}
}
}
},
/api/TzGemeinden: {
get: {
tags: [
"TzGemeinden"
],
responses: {
200: {
description: "Success"
}
}
}
},
/WeatherForecast: {
get: {
tags: [
"WeatherForecast"
],
operationId: "GetWeatherForecast",
responses: {
200: {
description: "Success",
content: {
text/plain: {
schema: {
type: "array",
items: {
$ref: "#/components/schemas/WeatherForecast"
}
}
},
application/json: {
schema: {
type: "array",
items: {
$ref: "#/components/schemas/WeatherForecast"
}
}
},
text/json: {
schema: {
type: "array",
items: {
$ref: "#/components/schemas/WeatherForecast"
}
}
}
}
}
}
}
}
},
components: {
schemas: {
Employee: {
type: "object",
properties: {
id: {
type: "string",
format: "uuid"
},
name: {
type: "string",
nullable: true
},
email: {
type: "string",
nullable: true
},
phone: {
type: "integer",
format: "int64"
},
salary: {
type: "integer",
format: "int64"
},
department: {
type: "string",
nullable: true
}
},
additionalProperties: false
},
WeatherForecast: {
type: "object",
properties: {
date: {
type: "string",
format: "date-time"
},
temperatureC: {
type: "integer",
format: "int32"
},
temperatureF: {
type: "integer",
format: "int32",
readOnly: true
},
summary: {
type: "string",
nullable: true
}
},
additionalProperties: false
}
}
}
}

Any idea whats going wrong here?

Thanks for any support.

br, Robert

Top Replies

100

Offline Pablo Moleri posted 8 months ago in reply to Anthony Marler +1 verified
Hi Anthony, Sorry that we missed your last reply. Anthony Marler said: But I think the issue is returning an IResult? Exactly. Results.Ok() is an...view reply »

16310

Offline Hristo Anastasov posted over 1 year ago

Hey Robert,

Currently, AppBuilder only support endpoints returning array or object. If the greyed out endpoints are ones that return primitive types, this is the reason for them to appear greyed out, let me verify that and provide more info. Meanwhile, is it possible that you reurn the "original" OpenAPi definiton file? It will contain quotes around namings, which is essential when parsing the content as JSON.
Cancel
Reply

Cancel
16310

Offline Hristo Anastasov posted over 1 year ago in reply to Hristo Anastasov
Hey Robert,

I did not heard from you, but I would not like you to wait for answer.

I once again investigated the definition. It actually is lacking a description of the response for the Employees endpoint (possibly for other endpoints too):

The yellow part is a good description inlcluding the content object with description and a reference to the schema of the expected response, which would be smth in the lines of:

I see there is an "Employee" schema in your definiton, so maybe this is what describes the Employees endpoint. Try to edit your definition and replace lines 65-70 with the following:

"responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } } } } }
Cancel
Reply

Cancel
20

Offline Anthony Marler posted 9 months ago in reply to Hristo Anastasov

Hello sorry to jump in here but I have the same issue. I think I understand what you are saying Hristo, (I'm an old programmer learning new tricks here!!) and I noticed that even in Jason Beres video https://www.youtube.com/watch?v=d9X0Q5iY8OE&t=2039s here at 34:07 you can see that several of the endpoints are greyed out - those greyed related to the changes he did at 25:13 when instead of returning a simple list (as I understand it) he is now returning a Http Results. Have I undersood that correctly?

If so, then my code is as below. Where my endpoint calls a function Data.PersonGetAll which itself calls a stored procedure via Dapper. But I think the issue is returning an IResult?

// this line part of Configure endpoint function

// then below

How can I change that to return something that AppBuilder can work with?

Thanks, And I appreciate this may be beyond the bounds of this support forum.

Thanks, Anthony
Cancel
Reply

Cancel
100

Verified Answer
Offline Pablo Moleri posted 8 months ago in reply to Anthony Marler
Hi Anthony,

Sorry that we missed your last reply.

Anthony Marler said:
But I think the issue is returning an IResult?

Exactly. Results.Ok() is an old method and loses all the type information which swagger (OpenAPI) needs to produce the correct metadata and App Builder to be able to "see" the return types.

In .Net 7+ you need to either:

Return Task<YourResponseType>, where OK is assumed.

Return TypedResult.Ok(yourResponse), where OK is explicit.

Any of those will be able to generate the correct OpenAPI Schema, and App Builder to consume it.

You can read more about typed results in .Net documentation TypedResults vs Results.

Regards,
Pablo
Cancel
Reply

Reject Answer

Cancel
20

Offline Anthony Marler posted 8 months ago in reply to Pablo Moleri
Hi thanks for the reply Pablo. I will just point out that my current code using Results.OK does work fine with Swagger,and with other projects that call the REST endpoints. I get back proper return codes 200, 404 etc. and Json data and the schema shows in Swagger too.

The documentation link you referred me to states. "Minimal endpoints support the following types of return values:"

string - This includes Task<string> and ValueTask<string>.

T (Any other type) - This includes Task<T> and ValueTask<T>.

IResult based - This includes Task<IResult> and ValueTask<IResult>.

So I would have expected AppBuilder should support Task<IResult> as I think that is where the issue is. Even if I change the return Results.OK(...) to return TypedResults.OK(...) app builder stays greyed out I suspect because the PersonGetAll() function returns a Task<IResult>.

My C# knowledge is far from complete as mentioned above. Any ideas how I can refactor those calls as all my many endpoints work in this manner. Thanks.
Cancel
Reply

Cancel