daxnet / hal Goto Github PK

Problem statement:

When using swagger with [ProducesResponseType(typeof(MeetingRoom), StatusCodes.Status200OK)]
The generated docs would produce a schema such as:

{
  "id": 0,
  "name": "string",
  "seats": 0
}

Where as in reality the response type is a wrapped HAL resource such as:

{
  "_links": {
    "self": {
      "href": string
    }
  },
  "id": number,
  "name": string,
  "seats": number
}

What approach would you suggest for integrating with swagger docs?

Couple of things come to my mind:

1. Custom ActionAttribute aka ProducesHalResponseType(typeof(MeetingRoom), StatusCodes.Status200OK)] which would attempt describe it accordingly.
2. Custom converters for serialization.

When generating a Json HAL with a list of two or more embedded resources (like orders example), the library returns an array of embedded objects:

{ "_links": { "self": { "href": "/orders" }, "curies": [ { "name": "ea", "href": "http://example.com/docs/rels/{rel}", "templated": true } ], "next": { "href": "/orders?page=2" }, "ea:find": { "href": "/orders{?id}", "templated": true } }, "currentlyProcessing": 14, "shippedToday": 20, "_embedded": { "ea:order": [ { "_links": { "self": { "href": "/orders/123" }, "ea:basket": { "href": "/baskets/98712" }, "ea:customer": { "href": "/customers/7809" } }, "total": 30.0, "currency": "USD", "status": "shipped" }, { "_links": { "self": { "href": "/orders/124" }, "ea:basket": { "href": "/baskets/97213" }, "ea:customer": { "href": "/customers/12369" } }, "total": 20.0, "currency": "USD", "status": "processing" } ] } }

but when the list has only one element, the library returns an embedded object instead of an array with only one element:

{ "_links": { "self": { "href": "/orders" }, "curies": [ { "name": "ea", "href": "http://example.com/docs/rels/{rel}", "templated": true } ], "next": { "href": "/orders?page=2" }, "ea:find": { "href": "/orders{?id}", "templated": true } }, "currentlyProcessing": 14, "shippedToday": 20, "_embedded": { "ea:order": { "_links": { "self": { "href": "/orders/123" }, "ea:basket": { "href": "/baskets/98712" }, "ea:customer": { "href": "/customers/7809" } }, "total": 30.0, "currency": "USD", "status": "shipped" } } }

I think it sholud return an array with one order, to be consistent with the previous result. ¿Is there any way to force the API to generate an array with one object instead?

Those Json Hal examples were generated using then Example test.

Thanks in advance!

Previously we used version 2.1.4 of Hal.AspNetCoreIntegration that supported .NET 6, but now we need to use a fresh one (2.2.0) that supports serializer configuration and unfortunately compatible with .NET 7 and .NET 8 only.
Is there is chance to add support of .NET 6 also?

From the Properties window of the Hal.AspNetCore.dll file it shows no values on File version and Product version fields, which is incorrect.

If resource is built from type that contains any enum, the result json will contain the integer value of the enum rather than its string name. Unfortunately, this behaviour can not be fixed by any settings in the application. According to my investigation, the reason of such behaviour is the fact that there is no way to setup JsonSerializerSettings field in SupportsHalAttribute and converters field in Resource class.

I tried to fix it in the fork by adding StringEnumConverter to converters and it resolved the issue.

Is it possible to make these fields configurable outside?

hi

im trying the following with fluent api

var reportsbuilder = new ResourceBuilder();
var reportresource = reportsbuilder.WithState(new { reportName = itemClientReport.ReportKey })
.AddSelfLink().WithLinkItem("/")
.AddLink("").WithLinkItem("")
.AddEmbedded("_report");

and after

reportresource.Resource(new ResourceBuilder().WithState(new { id = 1}));
string data = reportresource.Build().ToString();

so it's not taking the last line, the embedded it's giving me null .

but i put the complete

var reportsbuilder = new ResourceBuilder();
var reportresource = reportsbuilder.WithState(new { reportName = itemClientReport.ReportKey })
.AddSelfLink().WithLinkItem("/")
.AddLink("").WithLinkItem("")
.AddEmbedded("_report");
.Resource(new ResourceBuilder().WithState(new { id = 1 }));

string data = reportresource.Build().ToString();

it works by this way.

i need it separately because i need to add resources dependig of conditions into the embedded.

Any ideas?
Thanks.