| File: DefaultFilesExtensions.cs | Web Access |
| Project: src\aspnetcore\src\Middleware\StaticFiles\src\Microsoft.AspNetCore.StaticFiles.csproj (Microsoft.AspNetCore.StaticFiles) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.StaticFiles; using Microsoft.Extensions.Options; namespace Microsoft.AspNetCore.Builder; /// <summary> /// Extension methods for the DefaultFilesMiddleware /// </summary> public static class DefaultFilesExtensions { /// <summary> /// Enables default file mapping on the current path /// </summary> /// <param name="app"></param> /// <returns></returns> /// <remarks> /// Files are served from the path specified in <see cref="IWebHostEnvironment.WebRootPath"/> /// or <see cref="IWebHostEnvironment.WebRootFileProvider"/> which defaults to the 'wwwroot' subfolder. /// </remarks> public static IApplicationBuilder UseDefaultFiles(this IApplicationBuilder app) { ArgumentNullException.ThrowIfNull(app); return app.UseMiddleware<DefaultFilesMiddleware>(); } /// <summary> /// Enables default file mapping for the given request path /// </summary> /// <param name="app"></param> /// <param name="requestPath">The relative request path.</param> /// <returns></returns> /// <remarks> /// Files are served from the path specified in <see cref="IWebHostEnvironment.WebRootPath"/> /// or <see cref="IWebHostEnvironment.WebRootFileProvider"/> which defaults to the 'wwwroot' subfolder. /// </remarks> public static IApplicationBuilder UseDefaultFiles(this IApplicationBuilder app, string requestPath) { ArgumentNullException.ThrowIfNull(app); return app.UseDefaultFiles(new DefaultFilesOptions { RequestPath = new PathString(requestPath) }); } /// <summary> /// Enables default file mapping with the given options /// </summary> /// <param name="app"></param> /// <param name="options"></param> /// <returns></returns> public static IApplicationBuilder UseDefaultFiles(this IApplicationBuilder app, DefaultFilesOptions options) { ArgumentNullException.ThrowIfNull(app); ArgumentNullException.ThrowIfNull(options); return app.UseMiddleware<DefaultFilesMiddleware>(Options.Create(options)); } }