How do I map an endpoint to a static file in ASP. NET Core?

Question

I am building a single page web application in ASP .NET Core which requires me to map some URLs to an endpoint which serves a specific static file called "index.html".

Currently, I used a hack solution which maps all URLs to the endpoint.

_ = app.UseEndpoints(endpoints => {
    _ = endpoints.MapControllers();

    _ = endpoints.MapGet("/test", async context => {
        // I need some way to serve the static file in the response
        await context.Response.WriteAsync("Hello world");
    });

    // TODO replace with actual endpoint mapping
    //_ = endpoints.MapFallbackToFile("index.html");
});

Instead, I would like to map only a specific set of URLs to the endpoint. How do I accomplish this?

Range

Do you just want learn.microsoft.com/en-us/aspnet/core/fundamentals/… ? – Minutes

Answer 1

The solution was to implement URL rewriting to rewrite URLs to index.html as well as add use default files for the "/" root URL.

RewriteOptions rewriteOptions = new RewriteOptions()
                .AddRewrite("test", "index.html", true);

_ = app.UseRewriter(rewriteOptions);

_ = app.UseDefaultFiles();

This section of code comes before the UseRouting middleware call.

Range

Answer 2

You can use the Microsoft.AspNetCore.SpaServices.Extensions

public void ConfigureServices(IServiceCollection services)
{
  // ...

  services.AddSpaStaticFiles(configuration =>
  {
    configuration.RootPath = "static"; // Path to your index.html
  });

  // ...
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
  // ...

  app.Map("/yourSpaRoute", spaApp=>
  {
    spaApp.UseSpa(spa =>
    {
      spa.Options.SourcePath = "/static"; // source path
    });
  });

   // ...     
}

Millrun

Answer 3

I just wanted to redirect from / (web root) to index.htm I'm running a basic web app built on .NET Core 8.x

I tried so many answers and finally found the one that works at:

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/minimal-apis/responses?view=aspnetcore-8.0

The sample at the link above shows:

app.MapGet("/old-path", () => Results.Redirect("/new-path"));

I simply changed it to the following:

app.MapGet("/", () => Results.Redirect("/index.htm"));

Added it to my Program.cs before the calls to

app.UseStaticFiles();
app.UseDefaultFiles();
app.Run();

Now when the app starts up on http://localhost:5228/ it automatically loads my index.htm, which is located in my wwwroot folder.

Inunction