Skip to content

OData/WebApi

 
 

Repository files navigation

OData Web API

Introduction

OData Web API (i.e., ASP.NET Web API OData) is a server library built upon ODataLib and Web API.

Project structure

The project currently has the following branches:

master branch

This is the active development branch for OData WebApi and it is currently most actively iterated. The package name is Microsoft.AspNet.OData. The is the OData WebApi for ODL v7.x releases which contain breaking changes against ODL v6.

release branch

This is the release branch for OData WebApi, contains code base up to most recently stable WebApi release. The latest release version is 6.0.

gh-pages branch

The gh-pages branch contains documentation source for OData WebApi - tutorials, guides, etc. The documention source is in Markdown format. It is hosted at ODataLib Pages.

maintenance-aspnetcore

This is the maintenance branch for OData WebApi with ASP.NET Core support. The package name is Microsoft.AspNetCore.OData.

maintenance-V4 branch

This is the maintenance branch for OData WebApi based on ODL 6.x, which implements the ODataV4 protocol. The package name is Microsoft.AspNet.OData, with latest maintenance release version 5.10.

maintenance-V3 branch

This is the maintenance branch for OData WebApi based on ODL 5.x, which implements the ODataV3 protocol. The package name is Microsoft.AspNet.WebApi.OData, with latest maintenance release version 5.7.

maintenance-dnx branch

This is maintenance branch for an early prototype version of OData WebApi based on original ASP.NET Core, aka DNX. Package name is Microsoft.AspNet.OData. This is for project archive purpose only, is not active and doesn't accept contributions. It has only one release with information available here.

odata-v5.3-rtm v2.0-rtm v3-rtm v3.1-rtm v3.2-rtm branches

These are maintenance branches for previous RTMs. Project archives only, contributions not accepted.

Building

build.cmd

Testing

Each solution contains some test projects. Install this runner first, then open the project, build it and run all the tests in the test explorer. For running tests you must open the solution as Administrator. More detail at this.

Run tests in cmd

To run end-to-end tests, you need to open an elevated - Run as administrator - command prompt

  • build.cmd build projects, run unit tests, and OData end-to-end tests.

  • build.cmd quick or build.cmd -q build project, and run unit tests

Nightly builds

  1. In your NuGet Package Manager settings add the following package source:
  1. Package IDs

Contribution

Please refer to the CONTRIBUTION.md.

Samples

Please refer to the ODataSamples WebApi.

Debug

Please refer to the How to debug.

About

OData Web API: A server library built upon ODataLib and WebApi

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 143

Languages