Skip to content

feat: ✨ JsonApiOkAsync #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Erlend Ellefsen (erlendellefsen) merged 1 commit into from
Jan 2, 2026
Merged

feat: ✨ JsonApiOkAsync #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 61 additions & 8 deletions JsonApiToolkit/Controllers/JsonApiController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,57 @@ protected IActionResult JsonApiOk<T>(T entity, string resourceType)
return Ok(document);
}

/// <summary>
/// Returns 200 OK for a single resource queryable with JSON:API query support (filter, include).
/// Use this when you need includes to be automatically loaded from the database.
/// </summary>
protected async Task<IActionResult> JsonApiOkAsync<T>(
IQueryable<T> queryable,
string resourceType
)
where T : class
{
QueryParameters parameters = GetJsonApiQueryParameters();

var mappedIncludes = EfIncludePathHelper.MapIncludePathsToClrProperties<T>(
parameters.Include
);

var (mainFilters, includeFilters) = IncludeFilterParser.SeparateIncludeFilters(
parameters.Filter,
parameters.Include
);

IQueryable<T> filteredQuery = queryable;

// Apply main entity filters
if (mainFilters != null)
filteredQuery = filteredQuery.ApplyFilters(mainFilters, Logger);

// Apply includes (with or without filters)
if (includeFilters.Count > 0)
{
filteredQuery = filteredQuery.ApplyFilteredIncludes(
mappedIncludes,
includeFilters,
Logger
);
}
else if (mappedIncludes.Count > 0)
{
filteredQuery = filteredQuery.ApplyIncludes(mappedIncludes);
}

// Execute query for single entity
T? entity = await filteredQuery.FirstOrDefaultAsync().ConfigureAwait(false);

if (entity == null)
return JsonApiNotFound();

// Use existing JsonApiOk - entity now has includes loaded
return JsonApiOk(entity, resourceType);
}

/// <summary>
/// Returns 200 OK with a collection of resources as JSON:API document.
/// </summary>
Expand Down Expand Up @@ -178,14 +229,19 @@ string resourceType
includeFilters.Count,
typeof(T).Name
);
filteredQuery = filteredQuery.ApplyFilteredIncludes(mappedIncludes, includeFilters, Logger);
filteredQuery = filteredQuery.ApplyFilteredIncludes(
mappedIncludes,
includeFilters,
Logger
);
}
else if (mappedIncludes.Count > 0)
{
// Use single query with pagination to avoid EF Core split query issues
filteredQuery = parameters.Pagination != null
? filteredQuery.ApplyIncludesSingleQuery(mappedIncludes)
: filteredQuery.ApplyIncludes(mappedIncludes);
filteredQuery =
parameters.Pagination != null
? filteredQuery.ApplyIncludesSingleQuery(mappedIncludes)
: filteredQuery.ApplyIncludes(mappedIncludes);

Logger.LogDebug(
"Applied {IncludeCount} includes for {EntityType} using {QueryType}",
Expand All @@ -202,10 +258,7 @@ string resourceType

if (totalCount == 0 && parameters.Filter?.Filters?.Count > 0)
{
Logger.LogInformation(
"Query returned 0 results for {EntityType}",
typeof(T).Name
);
Logger.LogInformation("Query returned 0 results for {EntityType}", typeof(T).Name);
}
else if (totalCount > 1000 && parameters.Pagination == null)
{
Expand Down