Package springfox.documentation.oas.mappers

Class ServiceModelToOpenApiMapper

  • public abstract class ServiceModelToOpenApiMapper
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void afterMappingParameter​(springfox.documentation.service.RequestParameter from, io.swagger.v3.oas.models.parameters.Parameter target)  
      protected java.util.Map<java.lang.String,​io.swagger.v3.oas.models.media.Encoding> fromEncodings​(java.util.Collection<springfox.documentation.service.Encoding> encodings, springfox.documentation.service.ModelNamesRegistry namesRegistry)  
      protected java.util.Map<java.lang.String,​io.swagger.v3.oas.models.headers.Header> fromHeaders​(java.util.Collection<springfox.documentation.service.Header> headers, springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)  
      protected abstract io.swagger.v3.oas.models.media.MediaType fromRepresentation​(springfox.documentation.service.Representation each, springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)  
      protected io.swagger.v3.oas.models.media.Schema fromSimpleParameter​(java.util.Optional<springfox.documentation.service.SimpleParameterSpecification> value, springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)  
      protected io.swagger.v3.oas.models.responses.ApiResponses map​(java.util.Set<springfox.documentation.service.Response> from, springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)  
      protected abstract io.swagger.v3.oas.models.info.Contact map​(springfox.documentation.service.Contact from)  
      protected io.swagger.v3.oas.models.parameters.RequestBody map​(springfox.documentation.service.RequestBody from, springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)  
      protected abstract io.swagger.v3.oas.models.info.Info mapApiInfo​(springfox.documentation.service.ApiInfo from)  
      abstract io.swagger.v3.oas.models.OpenAPI mapDocumentation​(springfox.documentation.service.Documentation from)  
      protected abstract io.swagger.v3.oas.models.media.Encoding mapEncoding​(springfox.documentation.service.Encoding from, springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)  
      protected abstract io.swagger.v3.oas.models.ExternalDocumentation mapExternalDocs​(springfox.documentation.common.ExternalDocumentation from)  
      protected abstract io.swagger.v3.oas.models.headers.Header mapHeader​(springfox.documentation.service.Header from, springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)  
      protected abstract io.swagger.v3.oas.models.servers.Server mapServer​(springfox.documentation.service.Server from)  
      protected abstract io.swagger.v3.oas.models.servers.ServerVariable mapServerVariable​(springfox.documentation.service.ServerVariable from)  
      protected abstract io.swagger.v3.oas.models.tags.Tag mapTag​(springfox.documentation.service.Tag from)  
      protected io.swagger.v3.oas.models.parameters.Parameter.StyleEnum parameterStyle​(springfox.documentation.service.ParameterStyle from)  
      protected io.swagger.v3.oas.models.servers.ServerVariables serverVariableMap​(java.util.Collection<springfox.documentation.service.ServerVariable> serverVariables)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ServiceModelToOpenApiMapper

        public ServiceModelToOpenApiMapper()

    • Method Detail

      • mapDocumentation

        public abstract io.swagger.v3.oas.models.OpenAPI mapDocumentation​(springfox.documentation.service.Documentation from)

      • afterMappingParameter

        public void afterMappingParameter​(springfox.documentation.service.RequestParameter from,
                                  io.swagger.v3.oas.models.parameters.Parameter target)

      • parameterStyle

        protected io.swagger.v3.oas.models.parameters.Parameter.StyleEnum parameterStyle​(springfox.documentation.service.ParameterStyle from)

      • fromSimpleParameter

        protected io.swagger.v3.oas.models.media.Schema fromSimpleParameter​(java.util.Optional<springfox.documentation.service.SimpleParameterSpecification> value,
                                                                    springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)

      • map

        protected io.swagger.v3.oas.models.responses.ApiResponses map​(java.util.Set<springfox.documentation.service.Response> from,
                                                              springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)

      • map

        protected io.swagger.v3.oas.models.parameters.RequestBody map​(springfox.documentation.service.RequestBody from,
                                                              springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)

      • fromRepresentation

        protected abstract io.swagger.v3.oas.models.media.MediaType fromRepresentation​(springfox.documentation.service.Representation each,
                                                                               springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)

      • fromEncodings

        protected java.util.Map<java.lang.String,​io.swagger.v3.oas.models.media.Encoding> fromEncodings​(java.util.Collection<springfox.documentation.service.Encoding> encodings,
                                                                                                      springfox.documentation.service.ModelNamesRegistry namesRegistry)

      • mapEncoding

        protected abstract io.swagger.v3.oas.models.media.Encoding mapEncoding​(springfox.documentation.service.Encoding from,
                                                                       springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)

      • fromHeaders

        protected java.util.Map<java.lang.String,​io.swagger.v3.oas.models.headers.Header> fromHeaders​(java.util.Collection<springfox.documentation.service.Header> headers,
                                                                                                    springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)

      • mapHeader

        protected abstract io.swagger.v3.oas.models.headers.Header mapHeader​(springfox.documentation.service.Header from,
                                                                     springfox.documentation.service.ModelNamesRegistry modelNamesRegistry)

      • mapApiInfo

        protected abstract io.swagger.v3.oas.models.info.Info mapApiInfo​(springfox.documentation.service.ApiInfo from)

      • map

        protected abstract io.swagger.v3.oas.models.info.Contact map​(springfox.documentation.service.Contact from)

      • mapTag

        protected abstract io.swagger.v3.oas.models.tags.Tag mapTag​(springfox.documentation.service.Tag from)

      • mapServer

        protected abstract io.swagger.v3.oas.models.servers.Server mapServer​(springfox.documentation.service.Server from)

      • serverVariableMap

        protected io.swagger.v3.oas.models.servers.ServerVariables serverVariableMap​(java.util.Collection<springfox.documentation.service.ServerVariable> serverVariables)

      • mapServerVariable

        protected abstract io.swagger.v3.oas.models.servers.ServerVariable mapServerVariable​(springfox.documentation.service.ServerVariable from)

      • mapExternalDocs

        protected abstract io.swagger.v3.oas.models.ExternalDocumentation mapExternalDocs​(springfox.documentation.common.ExternalDocumentation from)