Package org.springdoc.webmvc.ui

Class SwaggerIndexPageTransformer

java.lang.Object
org.springdoc.ui.AbstractSwaggerIndexTransformer
org.springdoc.webmvc.ui.SwaggerIndexPageTransformer
All Implemented Interfaces:
SwaggerIndexTransformer, org.springframework.web.servlet.resource.ResourceTransformer
public class SwaggerIndexPageTransformer extends org.springdoc.ui.AbstractSwaggerIndexTransformer implements SwaggerIndexTransformer
The type Swagger index transformer.
Author:
bnasslahsen

  • Field Summary

    Fields inherited from class org.springdoc.ui.AbstractSwaggerIndexTransformer

    objectMapper, swaggerUiConfig, swaggerUiOAuthProperties

  • Constructor Summary

    Constructors
    Constructor
    Description
    SwaggerIndexPageTransformer(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SwaggerUiOAuthProperties swaggerUiOAuthProperties, SwaggerWelcomeCommon swaggerWelcomeCommon, org.springdoc.core.providers.ObjectMapperProvider objectMapperProvider)
    Instantiates a new Swagger index transformer.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.core.io.Resource
    transform(jakarta.servlet.http.HttpServletRequest request, org.springframework.core.io.Resource resource, org.springframework.web.servlet.resource.ResourceTransformerChain transformerChain)
     

    Methods inherited from class org.springdoc.ui.AbstractSwaggerIndexTransformer

    addCSRF, addCSRFLocalStorage, addCSRFSessionStorage, addInitOauth, addParameters, addSyntaxHighlight, defaultTransformations, overwriteSwaggerDefaultUrl, readFullyAsString, setConfiguredApiDocsUrl

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SwaggerIndexPageTransformer

      public SwaggerIndexPageTransformer(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SwaggerUiOAuthProperties swaggerUiOAuthProperties, SwaggerWelcomeCommon swaggerWelcomeCommon, org.springdoc.core.providers.ObjectMapperProvider objectMapperProvider)
      Instantiates a new Swagger index transformer.
      Parameters:
      swaggerUiConfig - the swagger ui config
      swaggerUiOAuthProperties - the swagger ui o auth properties
      swaggerWelcomeCommon - the swagger welcome common
      objectMapperProvider - the object mapper provider

  • Method Details

    • transform

      public org.springframework.core.io.Resource transform(jakarta.servlet.http.HttpServletRequest request, org.springframework.core.io.Resource resource, org.springframework.web.servlet.resource.ResourceTransformerChain transformerChain) throws IOException
      Specified by:
      transform in interface org.springframework.web.servlet.resource.ResourceTransformer
      Throws:
      IOException