base on ASP.NET Core OData: A server library built upon ODataLib and ASP.NET Core # ASP.NET Core OData
---
Component | Build | Status
--------|--------- |---------
ASP.NET Core OData|Rolling | [](https://identitydivision.visualstudio.com/OData/_build/latest?definitionId=2403&repoName=OData%2FAspNetCoreOData&branchName=main)
ASP.NET Core OData|Nightly | [](https://identitydivision.visualstudio.com/OData/_build/latest?definitionId=2404&repoName=OData%2FAspNetCoreOData&branchName=main)
.NET Foundation|Release|[](https://dev.azure.com/dotnet/OData/_apis/build/status/AspNetCoreOData/AspNetCoreOData-main-Yaml-release?branchName=main)
A server-side OData library for ASP.NET Core. Use this project to create OData services on top of ASP.NET Core and ODataLib. It provides routing, query handling, model building, formatters and more.
Quick links
- NuGet: https://www.nuget.org/packages/Microsoft.AspNetCore.OData/
- Documentation: https://learn.microsoft.com/odata/webapi-8/
- Samples: ./sample
- Source: https://github.com/OData/AspNetCoreOData
---
## Quick start
Using .NET CLI:
```bash
dotnet add package Microsoft.AspNetCore.OData
```
### Example - Configure OData
This simple example shows how to register OData and expose an entity set named `Products`.
```csharp
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;
using Microsoft.AspNetCore.OData;
using Microsoft.OData.Edm;
using Microsoft.OData.ModelBuilder;
var builder = WebApplication.CreateBuilder(args);
// Register controllers and OData
builder.Services
.AddControllers()
.AddOData(options =>
options.AddRouteComponents("odata", GetEdmModel())
.Select().Filter().OrderBy().Expand().Count().SetMaxTop(null));
var app = builder.Build();
if (app.Environment.IsDevelopment())
{
// Helpful only during development
app.UseODataRouteDebug();
}
app.UseRouting();
app.MapControllers();
app.Run();
static IEdmModel GetEdmModel()
{
var builder = new ODataConventionModelBuilder();
builder.EntitySet<Product>("Products");
return builder.GetEdmModel();
}
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public decimal Price { get; set; }
}
```
### Example controller (ODataController)
```csharp
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Routing.Controllers;
using Microsoft.AspNetCore.OData.Query;
public class ProductsController : ODataController
{
private static List<Product> products = new List<Product>
{
new Product { Id = 1, Name = "Product 1", Price = 10.0M },
new Product { Id = 2, Name = "Product 2", Price = 20.0M }
};
[EnableQuery]
public IActionResult Get()
{
return Ok(products);
}
[EnableQuery]
public IActionResult Get(int key)
{
var product = products.FirstOrDefault(p => p.Id == key);
if (product == null)
{
return NotFound();
}
return Ok(product);
}
}
```
For more examples (including Minimal API samples) see the `sample` folder in this repository.
---
## Samples
This repository includes a set of example applications under the `sample` directory. Notable samples:
- `sample/ODataRoutingSample` — a full Web API sample showing routing, $metadata and Swagger integration.
- `sample/ODataMiniApi` — examples of Minimal API style OData endpoints.
Run a sample:
```bash
cd sample/ODataRoutingSample
dotnet run
```
Then browse to `http://localhost:5000/odata/Products` (port may vary) to inspect the service.
---
## Github Repository
This is the official ASP.NET Core OData repository.
[ASP.NET Core OData](https://www.nuget.org/packages/Microsoft.AspNetCore.OData/8.0.0) is a server side library built upon ODataLib and ASP.NET Core.
**Blogs**:
* [$compute and $search in ASP.NET Core OData 8](https://devblogs.microsoft.com/odata/compute-and-search-in-asp-net-core-odata-8/)
* [API versioning extension with ASP.NET Core OData 8](https://devblogs.microsoft.com/odata/api-versioning-extension-with-asp-net-core-odata-8/)
* [Build formatter extensions in ASP.NET Core OData 8 and hooks in ODataConnectedService](https://devblogs.microsoft.com/odata/build-formatter-extensions-in-asp-net-core-odata-8-and-hooks-in-odataconnectedservice/)
* [Attribute Routing in ASP.NET Core OData 8.0 RC](https://devblogs.microsoft.com/odata/attribute-routing-in-asp-net-core-odata-8-0-rc/)
* [Routing in ASP.NET Core OData 8.0 Preview](https://devblogs.microsoft.com/odata/routing-in-asp-net-core-8-0-preview/)
* [ASP.NET Core OData 8.0 Preview for .NET 5](https://devblogs.microsoft.com/odata/asp-net-odata-8-0-preview-for-net-5/)
#### **Documentation**:
For comprehensive documentation, please refer to the following links:
- [ASP.NET Core OData Overview](https://learn.microsoft.com/odata/webapi-8/overview)
- [Getting Started](https://learn.microsoft.com/odata/webapi-8/getting-started)
- [Fundamentals Overview](https://learn.microsoft.com/odata/webapi-8/fundamentals/overview)
- [Tutorials](https://learn.microsoft.com/odata/webapi-8/tutorials/basic-crud)
- [OData Dev Blogs](https://devblogs.microsoft.com/odata/)
- [OData.org](https://www.odata.org/blog/)
**Example**:
* [ODataRoutingSample](https://github.com/OData/AspNetCoreOData/tree/main/sample/ODataRoutingSample): ASP.NET Core OData sample project in this repo.
- **`~/$odata`** gives a static routing table page of the service
- **`~/swagger`** gives a swagger/openapi page
- Append **`~/$openapi`** to each route gives a raw openapi OData page, for example, **`~/v1/$openapi`**
Please go to [sample](./sample) folder see more samples.
**Solution**:
* [AspNetCoreOData.sln](AspNetCoreOData.sln):
- Includes **Microsoft.AspNetCore.OData** project, Unit Test, E2E Test & Samples
* [AspNetCoreOData.NewtonsoftJson.sln](AspNetCoreOData.NewtonsoftJson.sln)
- Includes **Microsoft.AspNetCore.OData.NewtonsoftJson** project, Unit Test, E2E Test & Samples
---
## Building, Testing, Debugging and Release
### 1. Building and Testing in Visual Studio
Visual Studio 2022 is required to build the source project in order to support the `DateOnly` and `TimeOnly` types, which were introduced in .NET 6.
### 2. One-click build and test script in command line
Coming soon.
### 3. Debug
The symbol package is uploaded to nuget symbol server.
It supports source link debug. Remember to check `Enable Source Link support` if you debug using Visual Studio.
### 4. Nightly Builds
The nightly build process will upload NuGet packages for ASP.NET Core OData to:
* https://www.myget.org/gallery/webapinetcore
To connect to webapinightly feed, use this feed URL:
* https://www.myget.org/F/webapinetcore/api/v3/index.json (Your NuGet V3 feed URL (Visual Studio 2015+)
* https://www.myget.org/F/webapinetcore/api/v2 Your NuGet V2 feed URL (Visual Studio 2012+)
---
## Documentation
* [ODataRoutingSample](https://github.com/OData/AspNetCoreOData/tree/main/sample/ODataRoutingSample): ASP.NET Core OData sample project in this repo.
* [ASP.NET OData 8.0 Preview for .NET 5](https://devblogs.microsoft.com/odata/asp-net-odata-8-0-preview-for-net-5/): A blog introducing the project.
* [Our docs folder](./docs): Our current documentation
---
## Community
### 1. Contribution
Any contributions, feature requests, bugs and issues are welcome.
### 2. Reporting Security Issues
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](https://www.microsoft.com/msrc/faqs-report-an-issue). You can also find these instructions in this repo's [SECURITY.md](./SECURITY.md).
### 3. Support
- Issues: Report issues on [Github issues](https://github.com/OData/AspNetCoreOData/issues).
- Questions: Ask questions on [Stack Overflow](http://stackoverflow.com/questions/ask?tags=odata).
- Feedback: Please send mails to [
[email protected]](mailto:
[email protected]).
- Team blog: Please visit [https://devblogs.microsoft.com/odata/](https://devblogs.microsoft.com/odata/) and [http://www.odata.org/blog/](http://www.odata.org/blog/).
---
## Code of Conduct
This project has adopted the [.NET Foundation Contributor Covenant Code of Conduct](https://dotnetfoundation.org/about/policies/code-of-conduct). For more information see the [Code of Conduct FAQ](https://dotnetfoundation.org/about/faq).
---
## .NET Foundation
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).
AspNetCoreOData is a Copyright of © .NET Foundation and other contributors. It is licensed under [MIT License](https://github.com/OData/AspNetCoreOData/blob/main/License.txt)
", Assign "at most 3 tags" to the expected json: {"id":"8192","tags":[]} "only from the tags list I provide: []" returns me the "expected json"