OpenAPI documentation and examples for FlexQuery.NET endpoints.
Install this package when you expose FlexQuery-enabled endpoints and want automatic OpenAPI schema descriptions, parameter documentation, and canonical request/response examples in your OpenAPI document.
dotnet add package FlexQuery.NET.OpenApiThis package builds on Microsoft.AspNetCore.OpenApi and targets .NET 9 and .NET 10.
Either call the one-line registration:
builder.Services.AddFlexQueryOpenApi();Or configure AddOpenApi directly:
builder.Services.AddOpenApi(options =>
{
options.AddFlexQuery();
});This registers schema and operation transformers that enrich your OpenAPI document with:
- Descriptions for all FlexQuery model types (
FlexQueryRequest,FlexQueryParameters,QueryResult<T>, etc.) - Descriptions for query parameters (
filter,select,sort,page,pageSize,includeCount) - Canonical, production-quality examples for
FlexQueryRequest,FlexQueryParameters, andQueryResult<T>
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
builder.Services.AddFlexQueryOpenApi();
var app = builder.Build();
app.MapOpenApi();
app.Run();- Schema Descriptions — Human-readable descriptions for FlexQuery model types (
FlexQueryRequest,FlexQueryParameters,QueryResult<T>,FilterGroup,FilterCondition,SortNode,PagingOptions,Aggregate,HavingNode,IncludeNode,ProjectionMode,LogicOperator,AggregateFunction) - Parameter Documentation — Descriptions for query parameters (
filter,select,sort,page,pageSize,includeCount) - Canonical Examples — Production-quality, strongly typed examples for
FlexQueryRequest,FlexQueryParameters, andQueryResult<T>that immediately demonstrate FlexQuery capabilities - Zero Configuration — Single registration call, no options, no builders
- FlexQuery.NET — Core query engine
- FlexQuery.NET.AspNetCore — ASP.NET Core integration
- FlexQuery.NET.EntityFrameworkCore — EF Core execution
- FlexQuery.NET.Dapper — Dapper execution