Skip to content

wertzui/RESTworld

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RESTworld logo RESTworld

License: Unlicense

NuGet Version NuGet Downloads

NuGet Version NuGet Downloads

NuGet Version NuGet Downloads

NuGet Version NuGet Downloads

NuGet Version NuGet Downloads

NuGet Version NuGet Downloads

NuGet Version NuGet Downloads

NPM Version NPM Downloads

RESTworld is a developer-focused framework that turns ASP.NET Core and Entity Framework Core into a fully RESTful, HAL-compliant platform. It combines well-known building blocks with batteries-included conventions so you can deliver production-ready APIs quickly.

Key capabilities

  • Opinionated pipelines for read and CRUD scenarios, with extensibility hooks when you need to customize.
  • Out-of-the-box support for HAL, HAL-FORMS, and OData (query, paging, templated links).
  • AutoMapper, resource-based authorization, and API versioning baked into the request flow.
  • Telemetry via OpenTelemetry, health endpoints for readiness/liveness/startup, and Aspire integration for local orchestration.

Getting started

  1. Follow the Getting Started guide to scaffold your solution and wire up RESTworld services.
  2. Configure runtime behavior with Configuration, and review Pipeline Overview to choose the right pipeline.
  3. Secure your endpoints using Authorization and fine-tune DTO mappings with Mapping and Versioning.

Need a reference implementation? Explore src/Example/ExampleBlog.

Documentation map

The documentation targets developers who build APIs and client applications on top of the RESTworld libraries. If you're looking for a higher-level pitch, read the refreshed README-short.

Contributing and feedback

  • File issues or feature requests via GitHub Issues.
  • Share ideas or improvements through pull requests—guided by the documentation above.

Enjoy building RESTful applications with RESTworld!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published