BaseJsonApiController Endpoint Issue

[FrozenSilence]

SUMMARY

When extending the BaseJsonApiController endpoints are being created for methods that have not been overridden in the child controller and/or do not have annotations.

DETAILS

public class LocationsController(
    IJsonApiOptions options,
    IResourceGraph resourceGraph,
    ILoggerFactory loggerFactory,
    IResourceService<Location, uint> resourceService) : BaseJsonApiController<Location, uint>(options, resourceGraph, loggerFactory, resourceService)
{
    /// <inheritdoc />
    [HttpGet]
    [HttpHead]
    [Authorize(Policy = "view")]
    public override async Task<IActionResult> GetAsync(CancellationToken cancellationToken)
    {
        return await base.GetAsync(cancellationToken);
    }
}

Will generate

Route: api/locations
  Handler: Project.Controllers.LocationsController.GetAsync (Project)

Route: api/locations/{id}
  Handler: Project.Controllers.LocationsController.GetAsync (Project)

Route: api/locations/{id}
  Handler: Project.Controllers.LocationsController.GetAsync (Project)

Route: api/locations
  Handler: Project.Controllers.LocationsController.GetSecondaryAsync (Project)

Route: api/locations
  Handler: Project.Controllers.LocationsController.GetRelationshipAsync (Project)

Route: api/locations
  Handler: Project.Controllers.LocationsController.PostAsync (Project)

Route: api/locations
  Handler: Project.Controllers.LocationsController.PostRelationshipAsync (Project)

Route: api/locations
  Handler: Project.Controllers.LocationsController.PatchAsync (Project)

Route: api/locations
  Handler: Project.Controllers.LocationsController.PatchRelationshipAsync (Project)

Route: api/locations
  Handler: Project.Controllers.LocationsController.DeleteAsync (Project)

Route: api/locations
  Handler: Project.Controllers.LocationsController.DeleteRelationshipAsync (Project)

This also causes a problem because if you attempt to PATCH api/locations (without an id) you should receive a method not allowed but instead receive a 500-error stating it is ambiguous. Is this functionality intended?

Program.cs Middleware Order:

app.UseHttpsRedirection();
app.UseAuthentication();
app.UseRateLimiter();
app.UseAuthorization();
app.UseJsonApi();
app.MapControllers();
app.Run();

VERSIONS USED

• JsonApiDotNetCore version: 5.6.0
• ASP.NET Core version: 9.0.2
• Entity Framework Core version: 9.0.2
• Database provider: MySQL

[bkoelman]

Use a different base constructor (the longest), passing resourceService for the endpoints you want and null in the other places.

[FrozenSilence]

Use a different base constructor (the longest), passing resourceService for the endpoints you want and null in the other places.

Okay, I was hoping there was another way, but I'll do this. Thank you for the quick reply!

[bkoelman]

Why were you hoping for another way?

[FrozenSilence]

The process is a bit tedious with the need to define individual pieces of the resource services for hundreds of controllers as we migrate. Since we are migrating only parts of the API at a time we may only need GET for now, but a month later some may implement a PATCH method here and there. My hope was if I were to use the BaseJsonApiController and not the JsonApiController, it would only create endpoints that were specially overridden, and annotated much like ASPs ApiController. That was my interpretation of documentation at least.

I noticed the IJsonApiEndpointFilter in the master branch and thought that could be used to filter out anything that wasn't defined in the derivative class, but noticed it wasn't available in the version of the package I'm using.

[bkoelman]

Ok, I understand. Indeed IJsonApiEndpointFilter enables to manage this centrally, but it hasn't been released on nuget.org yet.

[FrozenSilence]

Is there a potential target date for a release on nuget.org that would have that interface?

[bkoelman]

I'm currently on vacation, but I suspect in a few weeks if all goes well. I'm in the process of validating resource inheritance support in OpenAPI. To enable that, I'm adding bits and pieces into the core framework, adapting them as needed. I don't want to release before that work has completed, as I won't be able to change it anymore.

[bkoelman]

@jhauserdev The latest release on nuget includes IJsonApiEndpointFilter now.

[FrozenSilence]

Thanks for the follow up!