XUnit3Helper.StartupModule 0.0.5-alpha

XUnit3Helper.StartupModule

This package is required by the XUnit3Helper.Integration. It contains an abstract startup module which you should use as a base for implementing your Web API.

Example — concise constructor syntax:

    public sealed class Startup(
        IWebHostEnvironment environment,
        ConfigurationManager configurationManager)
        : BaseStartupModule(environment, configurationManager)
    {
    }

Or using an explicit constructor that calls the base:

    public sealed class Startup
        : BaseStartupModule
    {
        public Startup(
            IWebHostEnvironment environment,
            ConfigurationManager configurationManager)
            : base(environment, configurationManager)
        {
        }
    }

You must also implement these methods:

• ConfigureConfigurationInternal

    protected abstract IConfiguration ConfigureConfigurationInternal(
        IWebHostEnvironment environment,
        ConfigurationManager configurationManager);

Example:

    protected override IConfiguration ConfigureConfigurationInternal(
        IWebHostEnvironment environment,
        ConfigurationManager configurationManager)
    {
        return configurationManager
            //Set the application content root path
            .SetBasePath(environment.ContentRootPath)
             //Add appsettings file
            .AddJsonFile("appsettings.json")
             //Add environment-specific appsettings file (optional)
            .AddJsonFile($"appsettings.{environment.EnvironmentName}.json", true)
             //Add environment variables
            .AddEnvironmentVariables()
            .Build();
    }

• ConfigureServices

    public override IServiceCollection ConfigureServices(IServiceCollection services);

Example:

    public override IServiceCollection ConfigureServices(IServiceCollection services)
    {
        services.AddCors();
        services.AddControllers();

        services.AddEndpointsApiExplorer();
        services.AddSwaggerGen();

        return services;
    }

• Configure

    public override IApplicationBuilder Configure(IApplicationBuilder app);

Example:

    public override IApplicationBuilder Configure(IApplicationBuilder app)
    {
        app.UseRouting();

        app.UseCors(policy => policy
            .AllowAnyOrigin()
            .AllowAnyHeader()
            .AllowAnyMethod());

        if (environment.IsDevelopment())
        {
            app.UseSwagger();
            app.UseSwaggerUI();
        }

        app.UseHttpsRedirection();
        app.UseAuthorization();
        app.UseAuthorization();

        app.UseEndpoints(configure => configure.MapControllers());

        return app;
    }

As a result, your Program.cs will look like this:

    var builder = WebApplication.CreateBuilder(args);

    var startup = new Startup(builder.Environment, builder.Configuration);

    startup.ConfigureServices(builder.Services);

    var applicationBuilder = builder.Build();
    startup.Configure(applicationBuilder);

    await applicationBuilder.RunAsync();