程序包 springfox.documentation.builders

类 ModelBuilder

java.lang.Object
springfox.documentation.builders.ModelBuilder
public class ModelBuilder extends Object

  • 构造器详细资料

    • ModelBuilder

      public ModelBuilder()

  • 方法详细资料

    • id

      public ModelBuilder id(String id)
      Updates the Id of the model, usually the type name
      参数:
      id - - identifier for the model
      返回:
      this

    • name

      public ModelBuilder name(String name)
      Updates the Name of the model
      参数:
      name - - name of the model
      返回:
      this

    • qualifiedType

      public ModelBuilder qualifiedType(String qualifiedType)
      Fully package qualified name of the model
      参数:
      qualifiedType - - package qualified name
      返回:
      this

    • properties

      public ModelBuilder properties(Map<String,ModelProperty> properties)
      Updates the model properties
      参数:
      properties - - map of properties by name
      返回:
      this

    • description

      public ModelBuilder description(String description)
      Update the description of the model
      参数:
      description - - description
      返回:
      this

    • baseModel

      public ModelBuilder baseModel(String baseModel)
      Update the based model
      参数:
      baseModel - - based model as in inherited parent model. We currently don't implement this feature
      返回:
      this

    • discriminator

      public ModelBuilder discriminator(String discriminator)
      Updates inheritance discriminator, used to identify inherited subclasses. We currently don't implement this feature
      参数:
      discriminator - - inheritance discriminator
      返回:
      this

    • subTypes

      public ModelBuilder subTypes(List<ModelReference> subTypes)
      Updates the subclasses for this model.
      参数:
      subTypes - - Models inheriting from this model
      返回:
      this
      从以下版本开始:
      2.8.1 We changed the subType to be a model refers

    • example

      @Deprecated public ModelBuilder example(String example)
      已过时。
      Updates the Example for the model
      参数:
      example - - example of the model
      返回:
      this
      从以下版本开始:
      2.8.1 Use the one which takes in an Object instead

    • example

      public ModelBuilder example(Object example)
      Updates the Example for the model
      参数:
      example - - example of the model
      返回:
      this
      从以下版本开始:
      2.8.1

    • type

      public ModelBuilder type(com.fasterxml.classmate.ResolvedType modelType)
      Represents the type information with full fidelity of generics
      参数:
      modelType - - resolved type that represents the model
      返回:
      this

    • xml

      public ModelBuilder xml(Xml xml)

    • build

      public Model build()