Back to Fastendpoints

Project Overview

.okf/project-overview.md

8.32.3 KB
Original Source

Project Overview

Purpose

FastEndpoints is a developer-oriented alternative to Minimal APIs and MVC for ASP.NET Core. It implements the REPR pattern (Request-Endpoint-Response) with low boilerplate. Public docs: https://fast-endpoints.com

Scope

Library monorepo, not a hosted product. Package inventory: monorepo-packages.md.

AreaExamples
Core HTTPFastEndpoints, FastEndpoints.Attributes, FastEndpoints.Core
Messaging / jobsFastEndpoints.Messaging*, FastEndpoints.JobQueues, FastEndpoints.CommandRules
Security / integrationsFastEndpoints.Security, AspVersioning, OData, HealthChecks
Docs / clientsFastEndpoints.OpenApi, FastEndpoints.OpenApi.Kiota, legacy Swagger / ClientGen*
Tooling / AOTFastEndpoints.Generator, FastEndpoints.Generator.Cli
TestingFastEndpoints.Testing, remote messaging testing
Addons (own version line)FastEndpoints.Mcp, FastEndpoints.A2A (Src/Agents/)

Consumers

  • App developers targeting ASP.NET Core net8.0 / net9.0 / net10.0
  • NuGet consumers; nothing is deployed as a service from this repo

Capabilities

  • Endpoint discovery (reflection or source-generated DiscoveredTypes)
  • FluentValidation, pre/post processors, mappers
  • In-process command/event bus and gRPC remote messaging
  • Job queues (storage SPI) and HTTP request idempotency (AddIdempotency)
  • JWT/cookie auth, feature flags (IFeatureFlag), X402 payment helpers
  • OpenAPI (Microsoft.AspNetCore.OpenApi), AOT-oriented generation

Status

  • Core version: Src/Directory.Build.props <Version> (never cite OKF)
  • Agents versions: per-csproj under Src/Agents/
  • Solutions: FastEndpoints.slnx (primary), NativeAot.slnx (AOT)

Non-goals

  • Not a hosted product
  • Roadmap, sponsorship, and API catalog live in the docs site / changelog
  • Public doc pages: sibling ../FE-Docs/ (workflows.md)

Glossary

TermMeaning
REPRRequest-Endpoint-Response
SUT / harnessSample apps under TestHarness/ used by integration tests
WAFWebApplicationFactory via FastEndpoints.Testing.AppFixture
DiscoveredTypesSource-generated type list for AOT-friendly registration

Sources

  • README.md
  • Src/Directory.Build.props
  • FastEndpoints.slnx