Skip to content

Latest commit

 

History

History
116 lines (89 loc) · 7.03 KB

README.md

File metadata and controls

116 lines (89 loc) · 7.03 KB
Raw

Microsoft Restier - OData Made Simple

Releases   |   Documentation   |   OData v4.01 Documentation

Build Status Release Status
Code of Conduct Twitter

What is Restier?

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.

What is OData?

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.

Getting Started

  1. Create an ASP.NET Classic or ASP.NET Core web project.
  2. Add the corresponding Restier package for the flavor of ASP.NET you're targeting: Microsoft.Restier.AspNet or Microsoft.Restier.AspNetCore.
  3. Add thhe corresponding Restier package for the flavor of Entity Framework you are targering: Microsoft.Restier.EntityFramework or Microsoft.Restier.EntityFrameworkCore
  4. Review the ASP.NET Classic or ASP.NET Core samples to help you get started.

Use Cases

Coming Soon!

Supported Platforms

Restier 1.1 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 Components

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 spinning up a separate IIS instance, as well as verify the availability of your custom convention-based interceptors.
  • Microsoft.Restier.AspNetCore.Swagger: Automatically generates Swagger documentation for your ASP.NET Core Restier service.

Ecosystem

Restier is used in solutions from:

Community

After a couple years in statis, Restier is in active development once again. The project is lead by Robert McLaws and Mike Pizzo.

Contributing

If you'd like to help out with the project, our Contributor's Handbook is also located in the Wiki.

Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. 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.

Contributors

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 Micah Rairdon
Mike Pizzo Jan-Willem Spuij
Congyong S Chris Woodruff
Mark Stafford
Ray Yao