() : unit

Returns: WebApplication

configureBuilder : WebApplicationBuilder -> 'a

The function to apply to the web application builder.

Returns: WebApplication

Example

Use this operation to enable easy integration testing.

In your Program.fs:

 let app configureBuilder =
     webApp {
         buildWith configureBuilder
         get "/hello" (fun () -> "🌎")
     }

 (app ignore).Run ()

 [<Fact>]
 let ``Hello, world`` () =
     task {
         use app = Program.app (fun builder -> builder.WebHost.UseTestServer ())
         do! app.StartAsync ()
         use client = app.GetTestClient ()
         let! response = client.GetStringAsync "hello"
         Assert.Equal ("🌎", response)
     }
     |> Async.AwaitTask
     |> Async.RunSynchronously

configureBuilder : WebApplicationBuilder -> 'a

The function to apply to the web application builder.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         builder (fun builder ->
             builder.Services.AddSingleton
                 (EnvironmentName builder.Environment.EnvironmentName))
     }

configureConfiguration : ConfigurationManager -> 'a

The function to apply to the app configuration.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         configuration (fun config -> config.AddIniFile "config.ini")
     }

key : string

The key to look up in the app configuration.

ctor : 'Value -> 'ConfiguredValue

The constructor to pass the configuration value into.

Returns: WebApplicationBuilder

Example

 {
   "AppSettings": {
     "SqlCommandTimeout": "00:05:00"
   }
 }

 type SqlCommandTimeout = SqlCommandTimeout of TimeSpan

 let app =
     webApp {
         configurationValue "AppSettings:SqlCommandTimeout" SqlCommandTimeout
     }

configureOptions : 'TOptions -> 'a

The action to apply to the options.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         configure (fun (jsonOptions : JsonOptions) ->
             jsonOptions.SerializerOptions.Converters.Add (JsonStringEnumConverter ()))
     }

name : string

The name of the connection string to look up in the ConnectionStrings section of the app configuration.

ctor : string -> 'ConnectionString

The constructor to pass the configuration value into.

Returns: WebApplicationBuilder

Example

 {
   "ConnectionStrings": {
     "SqlDb": "Data Source=localhost\\LocalDb;Initial Catalog=MyDb;IntegratedSecurity=true"
   }
 }

 type SqlDbConnectionString = SqlDbConnectionString of string

 let app =
     webApp {
         connectionString "SqlDb" SqlDbConnectionString
     }

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         environmentVariables
     }

configure : IConfiguration -> 'ConfiguredValue

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         fromConfig (fun config -> Service config["MyKey"])
     }

configureHost : ConfigureHostBuilder -> 'a

The function to apply to the host builder.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         host (fun host ->
             host.ConfigureHostOptions (fun options ->
                 options.BackgroundServiceExceptionBehavior <-
                     BackgroundServiceExceptionBehavior.StopHost))
     }

implementationFactory : IServiceProvider -> 'a

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         hostedService (fun serviceProvider ->
             MyHostedService (serviceProvider.GetRequireService<OtherService> ()))
     }

serviceType : Type

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         hostedService typeof<MyHostedService>
     }

path : string

The path of the JSON configuration file.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         jsonFile "auth.json"
     }

configureLogging : ILoggingBuilder -> 'a

The function to apply to the logging builder.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         logging (fun logging ->
             logging.ClearProviders ()
             logging.AddConsole ())
     }

path : string

The path of the JSON configuration file.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         optionalJsonFile "auth.json"
     }

serviceType : Type

The type of the service to add.

implementationFactory : IServiceProvider -> 'TImplementation

A function that produces the service implementation.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         scoped
             typeof<IService>
             (fun serviceProvider -> Service (serviceProvider.GetRequiredService<OtherService> ()))
     }

serviceType : Type

The type of the service to add.

implementationType : Type

The type of the service implementation to add.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         scoped typeof<IService> typeof<Service>
     }

serviceType : Type

The type of the service to add.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         scoped typeof<Service>
     }

configureServices : IServiceCollection -> ConfigurationManager -> 'a

The function to apply to the web application builder's service collection.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         services (fun services config ->
             services.Configure<MyOptions> ("MyOptionsName", config.GetSection "MyOptionsSection")
             services.AddEndpointsApiExplorer ()
             services.AddSwaggerGen ()
             services.AddControllers ())
     }

implementationInstance : 'TService

An object to use as the service implementation.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         singleton (Service ())
     }

serviceType : Type

The type of the service to add.

implementationInstance : obj

An object to use as the service implementation.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         singleton typeof<IService> (Service ())
     }

serviceType : Type

The type of the service to add.

implementationFactory : IServiceProvider -> 'TImplementation

A function that produces the service implementation.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         singleton
             typeof<IService>
             (fun serviceProvider -> Service (serviceProvider.GetRequiredService<OtherService> ()))
     }

serviceType : Type

The type of the service to add.

implementationType : Type

The type of the service implementation to add.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         singleton typeof<IService> typeof<Service>
     }

serviceType : Type

The type of the service to add.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         singleton typeof<Service>
     }

serviceType : Type

The type of the service to add.

implementationFactory : IServiceProvider -> 'TImplementation

A function that produces the service implementation.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         transient
             typeof<IService>
             (fun serviceProvider -> Service (serviceProvider.GetRequiredService<OtherService> ()))
     }

serviceType : Type

The type of the service to add.

implementationType : Type

The type of the service implementation to add.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         transient typeof<IService> typeof<Service>
     }

serviceType : Type

The type of the service to add.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         transient typeof<Service>
     }

configureApp : WebApplication -> 'a

The function to apply to the built web application.

Returns: WebApplication

Example

 let app =
     webApp {
         webApp (fun app ->
             app.UseSwagger ()
             app.UseSwaggerUI ()
             app.MapControllers ())
     }

configureApp : WebApplication -> 'a

The function to apply to the built web application.

Returns: WebApplication

Example

 let app =
     webApp {
         get "/hello" (fun () -> "🌎")
         webApp (fun app ->
             app.UseSwagger ()
             app.UseSwaggerUI ()
             app.MapControllers ())
     }

configureWebHost : ConfigureWebHostBuilder -> 'a

The function to apply to the web host builder.

Returns: WebApplicationBuilder

Example

 let app =
     webApp {
         webHost (fun webHost ->
             webHost.ConfigureAppConfiguration (fun context _configBuilder ->
                 context.HostingEnvironment.ApplicationName <- "MyApp"))
     }