Package org.springdoc.webmvc.ui

Class 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, swaggerUiConfigParameters, swaggerUiOAuthProperties

    • Constructor Summary

      Constructors 
      Constructor Description
      SwaggerIndexPageTransformer​(org.springdoc.core.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.SwaggerUiOAuthProperties swaggerUiOAuthProperties, org.springdoc.core.SwaggerUiConfigParameters swaggerUiConfigParameters, com.fasterxml.jackson.databind.ObjectMapper objectMapper, SwaggerWelcomeCommon swaggerWelcomeCommon)
      Instantiates a new Swagger index transformer.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.springframework.core.io.Resource transform​(javax.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, addInitOauth, addParameters, addSyntaxHighlight, defaultTransformations, overwriteSwaggerDefaultUrl, readFullyAsString

    • Constructor Detail

      • SwaggerIndexPageTransformer

        public SwaggerIndexPageTransformer​(org.springdoc.core.SwaggerUiConfigProperties swaggerUiConfig,
                                   org.springdoc.core.SwaggerUiOAuthProperties swaggerUiOAuthProperties,
                                   org.springdoc.core.SwaggerUiConfigParameters swaggerUiConfigParameters,
                                   com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                   SwaggerWelcomeCommon swaggerWelcomeCommon)
        Instantiates a new Swagger index transformer.
        Parameters:
        swaggerUiConfig - the swagger ui config
        swaggerUiOAuthProperties - the swagger ui o auth properties
        swaggerUiConfigParameters - the swagger ui config parameters
        objectMapper - the object mapper
        swaggerWelcomeCommon - the swagger welcome common

    • Method Detail

      • transform

        public org.springframework.core.io.Resource transform​(javax.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