Package springfox.documentation.spi.service.contexts

Class Defaults

  • public class Defaults
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Defaults()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Comparator<springfox.documentation.service.ApiDescription> apiDescriptionOrdering()  
      java.util.Comparator<springfox.documentation.service.ApiListingReference> apiListingReferenceOrdering()  
      java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> defaultExcludeAnnotations()  
      java.util.Set<java.lang.Class> defaultIgnorableParameterTypes()  
      java.util.Map<org.springframework.web.bind.annotation.RequestMethod,​java.util.List<springfox.documentation.service.ResponseMessage>> defaultResponseMessages()
      Deprecated. 
      java.util.Map<org.springframework.http.HttpMethod,​java.util.List<springfox.documentation.service.Response>> defaultResponses()
      Default response messages set on all api operations
      java.util.List<springfox.documentation.schema.AlternateTypeRule> defaultRules​(com.fasterxml.classmate.TypeResolver typeResolver)  
      java.util.Comparator<springfox.documentation.service.Operation> operationOrdering()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Defaults

        public Defaults()

    • Method Detail

      • defaultIgnorableParameterTypes

        public java.util.Set<java.lang.Class> defaultIgnorableParameterTypes()

      • defaultResponseMessages

        @Deprecated
public java.util.Map<org.springframework.web.bind.annotation.RequestMethod,​java.util.List<springfox.documentation.service.ResponseMessage>> defaultResponseMessages()
        Deprecated.
        Default response messages set on all api operations
        Returns:
        - map of method to response messages
        Since:
        3.0.0 Use defaultResponses() instead

      • defaultResponses

        public java.util.Map<org.springframework.http.HttpMethod,​java.util.List<springfox.documentation.service.Response>> defaultResponses()
        Default response messages set on all api operations
        Returns:
        - map of method to response messages

      • defaultExcludeAnnotations

        public java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> defaultExcludeAnnotations()

      • operationOrdering

        public java.util.Comparator<springfox.documentation.service.Operation> operationOrdering()

      • apiDescriptionOrdering

        public java.util.Comparator<springfox.documentation.service.ApiDescription> apiDescriptionOrdering()

      • apiListingReferenceOrdering

        public java.util.Comparator<springfox.documentation.service.ApiListingReference> apiListingReferenceOrdering()

      • defaultRules

        public java.util.List<springfox.documentation.schema.AlternateTypeRule> defaultRules​(com.fasterxml.classmate.TypeResolver typeResolver)