Restier is an API development framework for building standardized, OData V4 based RESTful services on .NET.
Restier is the spiritual successor to WCF Data Services. Instead of generating endless boilerplate code with the current Web API + OData toolchain, RESTier helps you boostrap a standardized, queryable HTTP-based REST interface in literally minutes. And that's just the beginning.
Like WCF Data Services before it, Restier provides simple and straightforward ways to shape queries and intercept submissions before and after they hit the database. And like Web API + OData, you still have the flexibility to add your own custom queries and actions with techniques you're already familiar with.
OData stands for the Open Data Protocol. OData enables the creation and consumption of RESTful APIs, which allow resources, defined in a data model and identified by using URLs, to be published and edited by Web clients using simple HTTP requests.
OData was originally designed by Microsoft to be a framework for exposing Entity Framework objects over REST services. The first concepts shipped as "Project Astoria" in 2007. By 2009, the concept had evolved enough for Microsoft to announce OData, along with a larger effort to push the format as an industry standard.
Work on the current version of the protocol (V4) began in April 2012, and was ratified by OASIS as an industry standard in Feb 2014.
- Create an ASP.NET Classic or ASP.NET Core web project.
- Add the corresponding Restier package for the flavor of ASP.NET you're targeting:
Microsoft.Restier.AspNetorMicrosoft.Restier.AspNetCore. - Add thhe corresponding Restier package for the flavor of Entity Framework you are targering:
Microsoft.Restier.EntityFrameworkorMicrosoft.Restier.EntityFrameworkCore - Review the ASP.NET Classic or ASP.NET Core samples to help you get started.
Coming Soon!
Restier 1.0 currently supports the following platforms:
- Classic ASP.NET 5.2.7 and later
- ASP.NET Core 6.0, 7.0, and 8.0 (Binaries targeting deprecated versions of .NET are still available on NuGet.org)
- Entity Framework 6.4 and later
- Entity Framework Core 6.0 and later
Restier is made up of the following components:
- Microsoft.Restier.AspNet & Microsoft.Restier.AspNetCore: Plugs into the OData/WebApi processing pipeline and provides query interception capabilities.
- Microsoft.Restier.Core: The base library that contains the core convention-based interception framework.
- Microsoft.Restier.EntityFramework & Microsoft.Restier.EntityFramework: Translates intercepted queries down to the database level to be executed.
- Microsoft.Restier.Breakdance: Unit test Restier services and components in-memory without spnning up a separate IIS instance, as well as verify the availability of your custom convention-based interceptors.
Restier is used in solutions from:
After a couple years in statis, Restier is in active development once again. The project is lead by Robert McLaws and Mike Pizzo.
The core development team meets twice a month on Microsoft Teams to discuss pressing items and work through the issues list. A history of those meetings can be found in the Wiki.
If you'd like to help out with the project, our Contributor's Handbook is also located in the Wiki.
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) [email protected]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter. You can also find these instructions in this repo's SECURITY.md.
Special thanks to everyone involved in making RESTier the best API development platform for .NET. The following people have made various contributions to the codebase:
| Microsoft | External |
|---|---|
| Lewis Cheng | James Caldwell |
| Challen H | Angel Garay |
| Eric Erhardt | Cengiz Ilerler |
| Vincent He | Kemal M |
| Dong Liu | Mateusz Malicki |
| Layla Liu | Robert McLaws |
| Fan Ouyang | Jan-Willem Spuij |
| Mike Pizzo | Chris Woodruff |
| Congyong S | |
| Mark Stafford | |
| Ray Yao |