using System.Collections.Generic; using Jellyfin.Api.Middleware; using MediaBrowser.Common.Net; using MediaBrowser.Controller.Configuration; using Microsoft.AspNetCore.Builder; using Microsoft.OpenApi.Models; namespace Jellyfin.Server.Extensions { /// /// Extensions for adding API specific functionality to the application pipeline. /// public static class ApiApplicationBuilderExtensions { /// /// Adds swagger and swagger UI to the application pipeline. /// /// The application builder. /// The server configuration. /// The updated application builder. public static IApplicationBuilder UseJellyfinApiSwagger( this IApplicationBuilder applicationBuilder, IServerConfigurationManager serverConfigurationManager) { // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), // specifying the Swagger JSON endpoint. var baseUrl = serverConfigurationManager.GetNetworkConfiguration().BaseUrl.Trim('/'); var apiDocBaseUrl = serverConfigurationManager.GetNetworkConfiguration().BaseUrl; if (!string.IsNullOrEmpty(baseUrl)) { baseUrl += '/'; } return applicationBuilder .UseSwagger(c => { // Custom path requires {documentName}, SwaggerDoc documentName is 'api-docs' c.RouteTemplate = "{documentName}/openapi.json"; c.PreSerializeFilters.Add((swagger, httpReq) => { swagger.Servers = new List { new OpenApiServer { Url = $"{httpReq.Scheme}://{httpReq.Host.Value}{apiDocBaseUrl}" } }; }); }) .UseSwaggerUI(c => { c.DocumentTitle = "Jellyfin API"; c.SwaggerEndpoint($"/{baseUrl}api-docs/openapi.json", "Jellyfin API"); c.InjectStylesheet($"/{baseUrl}api-docs/swagger/custom.css"); c.RoutePrefix = "api-docs/swagger"; }) .UseReDoc(c => { c.DocumentTitle = "Jellyfin API"; c.SpecUrl($"/{baseUrl}api-docs/openapi.json"); c.InjectStylesheet($"/{baseUrl}api-docs/redoc/custom.css"); c.RoutePrefix = "api-docs/redoc"; }); } /// /// Adds IP based access validation to the application pipeline. /// /// The application builder. /// The updated application builder. public static IApplicationBuilder UseIPBasedAccessValidation(this IApplicationBuilder appBuilder) { return appBuilder.UseMiddleware(); } /// /// Adds LAN based access filtering to the application pipeline. /// /// The application builder. /// The updated application builder. public static IApplicationBuilder UseLanFiltering(this IApplicationBuilder appBuilder) { return appBuilder.UseMiddleware(); } /// /// Enables url decoding before binding to the application pipeline. /// /// The . /// The updated application builder. public static IApplicationBuilder UseQueryStringDecoding(this IApplicationBuilder appBuilder) { return appBuilder.UseMiddleware(); } /// /// Adds base url redirection to the application pipeline. /// /// The application builder. /// The updated application builder. public static IApplicationBuilder UseBaseUrlRedirection(this IApplicationBuilder appBuilder) { return appBuilder.UseMiddleware(); } /// /// Adds a custom message during server startup to the application pipeline. /// /// The application builder. /// The updated application builder. public static IApplicationBuilder UseServerStartupMessage(this IApplicationBuilder appBuilder) { return appBuilder.UseMiddleware(); } /// /// Adds a WebSocket request handler to the application pipeline. /// /// The application builder. /// The updated application builder. public static IApplicationBuilder UseWebSocketHandler(this IApplicationBuilder appBuilder) { return appBuilder.UseMiddleware(); } /// /// Adds robots.txt redirection to the application pipeline. /// /// The application builder. /// The updated application builder. public static IApplicationBuilder UseRobotsRedirection(this IApplicationBuilder appBuilder) { return appBuilder.UseMiddleware(); } /// /// Adds /emby and /mediabrowser route trimming to the application pipeline. /// /// /// This must be injected before any path related middleware. /// /// The application builder. /// The updated application builder. public static IApplicationBuilder UsePathTrim(this IApplicationBuilder appBuilder) { return appBuilder.UseMiddleware(); } } }