ApiApplicationBuilderExtensions.cs 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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. // Custom path requires {documentName}, SwaggerDoc documentName is 'api-docs'
  31. c.RouteTemplate = $"/{baseUrl}{{documentName}}/openapi.json";
  32. })
  33. .UseSwaggerUI(c =>
  34. {
  35. c.DocumentTitle = "Jellyfin API";
  36. c.SwaggerEndpoint($"/{baseUrl}api-docs/openapi.json", "Jellyfin API");
  37. c.RoutePrefix = $"{baseUrl}api-docs/swagger";
  38. })
  39. .UseReDoc(c =>
  40. {
  41. c.DocumentTitle = "Jellyfin API";
  42. c.SpecUrl($"/{baseUrl}api-docs/openapi.json");
  43. c.RoutePrefix = $"{baseUrl}api-docs/redoc";
  44. });
  45. }
  46. }
  47. }