Skip to content
Docs Try Aspire

DataApiBuilderHostingExtension Methods

Class Methods 2 members
Provides extension methods for adding DataApiBuilder api to an Hosting.IDistributedApplicationBuilder.
AddDataAPIBuilder(IDistributedApplicationBuilder, string, string[]) Section titled AddDataAPIBuilder(IDistributedApplicationBuilder, string, string[]) extension IResourceBuilder<DataApiBuilderContainerResource>
Adds a DataAPIBuilder application to the application model. Executes the pre-built containerized DataAPIBuilder engine.
public static class DataApiBuilderHostingExtension
{
public static IResourceBuilder<DataApiBuilderContainerResource> AddDataAPIBuilder(
this IDistributedApplicationBuilder builder,
string name,
params string[] configFilePaths)
{
// ...
}
}
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder to add the resource to.
name string The name of the resource.
configFilePaths string[] The path to the config or schema file(s) for Data API Builder.
IResourceBuilder<DataApiBuilderContainerResource> A reference to the ApplicationModel.IResourceBuilder`1.
At this time, this .NET Aspire DAB integration only supports HTTPS ports. You can deploy DAB with HTTPS and custom certs in production.
AddDataAPIBuilder(IDistributedApplicationBuilder, string, int?, string[]) Section titled AddDataAPIBuilder(IDistributedApplicationBuilder, string, int?, string[]) extension IResourceBuilder<DataApiBuilderContainerResource>
Adds a DataAPIBuilder application to the application model. Executes the pre-built containerized DataAPIBuilder engine.
public static class DataApiBuilderHostingExtension
{
public static IResourceBuilder<DataApiBuilderContainerResource> AddDataAPIBuilder(
this IDistributedApplicationBuilder builder,
string name,
int? httpPort = null,
params string[] configFilePaths)
{
// ...
}
}
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder to add the resource to.
name string The name of the resource.
httpPort int? optional The HTTP port number for the Data API Builder container.
configFilePaths string[] The path to the config or schema file(s) for Data API Builder.
IResourceBuilder<DataApiBuilderContainerResource> A reference to the ApplicationModel.IResourceBuilder`1.
At this time, this .NET Aspire DAB integration only supports HTTPS ports. You can deploy DAB with HTTPS and custom certs in production.