Interface IDocumentDescriptionLinkProvider

Namespace

JsonApiDotNetCore.Serialization.Response

Assembly

JsonApiDotNetCore.dll

Provides the value for the "describedby" link in https://jsonapi.org/format/#document-top-level.

public interface IDocumentDescriptionLinkProvider

Methods

GetUrl()

Gets the URL for the "describedby" link, or null when unavailable.

string? GetUrl()

Returns

string

Remarks

The returned URL can be absolute or relative. If possible, it gets converted based on UseRelativeLinks.