Back to Devexpress

WebApiStartupExtensions.AddXafWebApi(IServiceCollection, IConfiguration, Action<WebApiOptions>) Method

expressappframework-devexpress-dot-expressapp-dot-webapi-dot-services-dot-webapistartupextensions-dot-addxafwebapi-x28-iservicecollection-iconfiguration-action-webapioptions-x29.md

latest3.8 KB
Original Source

WebApiStartupExtensions.AddXafWebApi(IServiceCollection, IConfiguration, Action<WebApiOptions>) Method

An extension method that adds Web API services to the service collection.

Namespace : DevExpress.ExpressApp.WebApi.Services

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

NuGet Package : DevExpress.ExpressApp.WebApi

Declaration

csharp
public static XafWebApiBuilder AddXafWebApi(
    this IServiceCollection services,
    IConfiguration configuration,
    Action<WebApiOptions> configureOptions
)
vb
<ExtensionAttribute>
Public Shared Function AddXafWebApi(
    services As IServiceCollection,
    configuration As IConfiguration,
    configureOptions As Action(Of WebApiOptions)
) As XafWebApiBuilder

Parameters

NameTypeDescription
servicesIServiceCollection

A service collection for which the AddXafWebApi extension method is called.

| | configuration | IConfiguration |

The application configuration.

| | configureOptions | Action<WebApiOptions> |

An Action delegate that configures Web API services.

|

Returns

Type
DevExpress.ExpressApp.WebApi.Services.XafWebApiBuilder

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

Add and Protect CRUD Web API Endpoints

WebApiStartupExtensions Class

WebApiStartupExtensions Members

DevExpress.ExpressApp.WebApi.Services Namespace