All docs
V21.2
21.2
21.1
The page you are viewing does not exist in version 21.1. This link will take you to the root page.
20.2
The page you are viewing does not exist in version 20.2. This link will take you to the root page.
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

Backend Web API Service (CTP)

  • 2 minutes to read

Important

We do not recommend that you use the Backend Web API Service in production code. We made this service available to gather feedback from anyone who considers it for future use.

Overview

You can utilize the Backend Web API Service (Web API) to reuse existing data models and Security System settings (users, roles, and permissions) stored in an XAF application database (backend) in the non-XAF .NET application. This service can be hosted as part of a Blazor Server project or as a standalone ASP.NET Core project.

The Web API creates URLs (endpoints) that allow you to execute CRUD operations with business objects. It uses ASP.NET Core OData 8.0 (OData v4.0) to support paging, filters, and other OData options. The current Web API version supports the XPO ORM only.

XAF Web API

The Web API utilizes Swagger to display and test endpoints. You can also test them with other platforms (for example, Postman).

The Web API is available in v21.2 and later.

How to Use

You can add the Web API to an existing Blazor Server project or create a new project with this service:

After you add the Web API to your project, you can use it as described in the following article: Create Endpoints and Test the Web API.

Authentication Options

The Web API supports all standard ASP.NET Core authentication techniques that you can specify in the MySolution.WebApi\Startup.cs file. See the following topic for details: Authentication in Web API Projects.

Use the Web API as the Middle Tier Server in WinForms Applications

You can also use the Web API as the Middle Tier Server in WinForms Applications. See the following topics for details: