Breeze.Server.WebApi2 2.0.3

dotnet add package Breeze.Server.WebApi2 --version 2.0.3                
NuGet\Install-Package Breeze.Server.WebApi2 -Version 2.0.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Breeze.Server.WebApi2" Version="2.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Breeze.Server.WebApi2 --version 2.0.3                
#r "nuget: Breeze.Server.WebApi2, 2.0.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Breeze.Server.WebApi2 as a Cake Addin
#addin nuget:?package=Breeze.Server.WebApi2&version=2.0.3

// Install Breeze.Server.WebApi2 as a Cake Tool
#tool nuget:?package=Breeze.Server.WebApi2&version=2.0.3                

Breeze Data Management for .NET Servers

Breeze is a library that helps you manage data in rich client applications. If you store data in a database, query and save those data as complex object graphs, and share these graphs across multiple screens of your JavaScript or C# client, Breeze is for you.

Client-side querying, caching, dynamic object graphs, change tracking and notification, model validation, batch save, offline … all part of rich data management with Breeze. Breeze clients communicate with any remote service that speaks HTTP and JSON.

Breeze lets you develop applications using the same powerful idioms on the client and server. You can

  • query with a rich query syntax
  • navigate the graph of related entities
  • track changes as you add/change/delete entities
  • perform client-side validation
  • save all changes in a single transaction
  • use the same entity model on the server and client

Install from NuGet

.NET Framework

For .NET Framework, find the following packages in NuGet.

Note: Version 2.0.2 and above are for .NET Framework 4.8; versions below that are for 4.7 and below.

For a typical EFCore application, you would install the first two packages. For an NHibernate application, install the first package and Breeze.Persistence.NH. The last two packages are dependencies that are automatically installed by the other packages.

.NET Core

See the docs for .NET Core NuGet packages

Documentation

See the docs for more info about what Breeze does and how to use it.

Set the release notes for changes in the latest version.

Examples

See some examples of how to use Breeze .NET server with clients written in Angular, Aurelia, React, and Vue in the Northwind-Demo.

See the TempHire application for a richer example showing proper architectural patterns.

Sources

The sources for this package are in the breeze.server.net repo. Please file issues and pull requests against that repo.

Upgrading from .NET Framework to Core

The underlying concepts are the same, but there are a few major changes

  • The ContextProvider class is now PersistenceManager.
  • The [BreezeController] and [EnableBreezeQuery] attributes have been replaced by [BreezeQueryFilter] attribute.
  • Breeze JSON query format is preferred over OData. You will need to use Breeze 2.x on the client, and use the UriBuilderJsonAdapter (not the UriBuilderOdataAdapter).

See the Northwind-Demo for steps to set up a new .NET Core server.

See the UPGRADE document for information on upgrading Breeze Client from 1.x to 2.x.

Building Breeze

The recent sources and solutions are in the breeze.server.net repo under the AspNet folder. Building is just a matter of:

  1. Installing the required version of .NET SDK
  2. Opening the appropriate solution in Visual Studio
  3. Restoring NuGet packages
  4. Rebuilding the solution

Test solutions is Breeze.AspNet.InternalTests.sln in the root folder.


If you have discovered a bug or missing feature, please create an issue in the breeze.server.net github repo.

If you have questions about using Breeze, please ask on Stack Overflow.

If you need help developing your application, please contact us at IdeaBlade.

Product Compatible and additional computed target framework versions.
.NET Framework net is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Breeze.Server.WebApi2:

Package Downloads
Breeze.WebApi2.EF6

The files and references that are essential for a Breeze ASP.NET Web API 2.2 client and server on Entity Framework 6. (Not for use with .NET Core or ASP.Net Core)

HotTowel.Angular.Breeze

Want to build a SPA but can't decide where to start? Use Hot Towel and in seconds you'll have a SPA and all the tools you need to build on it! Hot Towel Angular creates a great starting point for building a SPA using Angular for data bindings, navigation and UI, and Breeze for data management. Hot Towel Angular also adds pop-up toasts with Toastr, date formatting with Moment, and styling with Twitter Bootstrap. Hot Towel: Because you don't want to go to the SPA without one! * Hot Towel Angular is shown in the "Building Apps with Angular and Breeze" course at http://jpapa.me/spangz

Breeze.WebApi2.NH

The files and references that are essential for a Breeze ASP.NET Web API 2.2 client and server on NHibernate. (Not for use with .NET Core or ASP.Net Core)

HotTowelTypescript

HotTowel Typescript is a SPA template. This is John Papas HotTowel Angular Breeze template written in Typescript. There are some changes to the project structure, mainly naming of controllers and directives. Using Web Essentials plugin for Visual Studio is highly recommended when using Typescript. You need to generate the .js files from TypeScript files before you run the project. *UI fixes: - When going from small screen to large screen after selecting a menuitem the sidebar contained no menuitems - When clicking on a menuitem in a small screen the menu now closes Version 2.2.2: * Fixed issue with bootstrap.dialog not opening as it should * Breeze.Server.WebApi2 1.4.16 was causing dependency issue and preventing install in VS2013.4 Version 2.1: * Removed .js files, use Web Essentials VS plugin to recreate them * Fixed the startup spinner not showing * Fixed an error with logFn, causing it to only log 'info' messages

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.3 10,415 2/11/2023
2.0.2 584 2/10/2023
2.0.1 42,377 12/20/2018
1.6.6 111,325 2/2/2018
1.6.5 56,779 6/1/2017
1.6.4 34,693 3/9/2017
1.6.3 2,678 3/9/2017
1.6.0 82,940 12/1/2016
1.5.5 104,148 2/8/2016
1.5.4 113,706 5/5/2015
1.5.3 29,902 1/22/2015
1.5.2 9,366 12/11/2014
1.5.1 7,344 10/24/2014
1.5.0 96,049 8/30/2014
1.4.17 6,855 8/19/2014
1.4.16 10,304 7/14/2014
1.4.15 1,989 7/13/2014
1.4.14 6,326 6/23/2014
1.4.13 7,866 6/2/2014
1.4.12 9,894 5/10/2014
1.4.11 21,448 3/8/2014
1.4.9 3,621 3/1/2014
1.4.8 17,440 1/7/2014
1.4.7 6,473 12/12/2013
1.4.6 4,517 11/24/2013
1.4.5 11,578 10/28/2013

Please review the Breeze release notes at https://breeze.github.io/doc-net/release-notes.html