ApiApplicationBuilderExtensions.cs 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. using MediaBrowser.Controller.Configuration;
  2. using Microsoft.AspNetCore.Builder;
  3. namespace Jellyfin.Server.Extensions
  4. {
  5. /// <summary>
  6. /// Extensions for adding API specific functionality to the application pipeline.
  7. /// </summary>
  8. public static class ApiApplicationBuilderExtensions
  9. {
  10. /// <summary>
  11. /// Adds swagger and swagger UI to the application pipeline.
  12. /// </summary>
  13. /// <param name="applicationBuilder">The application builder.</param>
  14. /// <param name="serverConfigurationManager">The server configuration.</param>
  15. /// <returns>The updated application builder.</returns>
  16. public static IApplicationBuilder UseJellyfinApiSwagger(
  17. this IApplicationBuilder applicationBuilder,
  18. IServerConfigurationManager serverConfigurationManager)
  19. {
  20. // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
  21. // specifying the Swagger JSON endpoint.
  22. var baseUrl = serverConfigurationManager.Configuration.BaseUrl.Trim('/');
  23. if (!string.IsNullOrEmpty(baseUrl))
  24. {
  25. baseUrl += '/';
  26. }
  27. return applicationBuilder
  28. .UseSwagger(c =>
  29. {
  30. c.RouteTemplate = $"/{baseUrl}api-docs/{{documentName}}/openapi.json";
  31. })
  32. .UseSwaggerUI(c =>
  33. {
  34. c.DocumentTitle = "Jellyfin API v1";
  35. c.SwaggerEndpoint($"/{baseUrl}api-docs/v1/openapi.json", "Jellyfin API v1");
  36. c.RoutePrefix = $"{baseUrl}api-docs/v1/swagger";
  37. })
  38. .UseReDoc(c =>
  39. {
  40. c.DocumentTitle = "Jellyfin API v1";
  41. c.SpecUrl($"/{baseUrl}api-docs/v1/openapi.json");
  42. c.RoutePrefix = $"{baseUrl}api-docs/v1/redoc";
  43. });
  44. }
  45. }
  46. }