Back to Devexpress

WebApiOptions.BusinessObject<T>() Method

expressappframework-devexpress-dot-expressapp-dot-webapi-dot-services-dot-webapioptions-dot-businessobject-1.md

latest2.6 KB
Original Source

WebApiOptions.BusinessObject<T>() Method

Generates HTTP endpoints for the business object class passed as a parameter.

Namespace : DevExpress.ExpressApp.WebApi.Services

Assembly : DevExpress.ExpressApp.WebApi.v25.2.dll

NuGet Package : DevExpress.ExpressApp.WebApi

Declaration

csharp
public BusinessObjectConfigurator<T> BusinessObject<T>()
    where T : class
vb
Public Function BusinessObject(Of T As Class) As BusinessObjectConfigurator(Of T)

Type Parameters

NameDescription
T

The business object class for which the Web API Service generates HTTP endpoints.

|

Returns

Type
DevExpress.ExpressApp.WebApi.Services.BusinessObjectConfigurator<T>

Remarks

The following code creates endpoints for the ApplicationUser and Contact business objects:

File: MySolution.WebApi\Startup.cs (MySolution.Blazor.Server\Startup.cs)

csharp
using MySolution.Module.BusinessObjects;
namespace MySolution.WebApi {
    public class Startup {
        public Startup(IConfiguration configuration) {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // ...
        public void ConfigureServices(IServiceCollection services) {
            // ...
            services.AddXafWebApi(Configuration, options => {
                options.BusinessObject<ApplicationUser>();
                options.BusinessObject<Contact>();
            })
            // in XPO applications, uncomment the following line
            // .AddXpoServices(); 
            // ...
        }
        // ...
    }
}

See Also

Backend Web API Service / REST API

Add and Protect CRUD Web API Endpoints

WebApiOptions Class

WebApiOptions Members

DevExpress.ExpressApp.WebApi.Services Namespace