程序包 springfox.documentation.builders

类 OperationBuilder

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

  • 构造器详细资料

  • 方法详细资料

    • method

      public OperationBuilder method(org.springframework.http.HttpMethod method)
      Updates the http method
      参数:
      method - - http method, one of GET, POST, PUT etc.
      返回:
      this

    • summary

      public OperationBuilder summary(String summary)
      Updates the operation summary
      参数:
      summary - - operation summary
      返回:
      this

    • notes

      public OperationBuilder notes(String notes)
      Updates the operation notes
      参数:
      notes - - notes to describe the operation
      返回:
      this

    • uniqueId

      public OperationBuilder uniqueId(String uniqueId)
      Updates the uniqueId for the operation. This will be used to seed the unique id
      参数:
      uniqueId - - uniqueId for the operation
      返回:
      this

    • codegenMethodNameStem

      public OperationBuilder codegenMethodNameStem(String codeGenMethodNameStem)
      This is an optional override that provides a custom method name stem, such that the method name that is generated for the purposes of code-gen can be customized. However it must be kept in mind that in-order the guarantee uniqueness of the name for code-gen the algorithm will still try to append and indexer at the end of it e.g. someMethod_1, someMethod_2 etc. to preserve uniqueness in the case there are duplicate names.
      参数:
      codeGenMethodNameStem - - provides a stem for the operation name as it will be used for code generation
      返回:
      this

    • position

      public OperationBuilder position(int position)
      Updates the index of the operation
      参数:
      position - - position is used to sort the operation in a particular order
      返回:
      this

    • produces

      public OperationBuilder produces(Set<String> mediaTypes)
      Updates the existing media types with new entries that this documentation produces
      参数:
      mediaTypes - - new media types
      返回:
      this

    • consumes

      public OperationBuilder consumes(Set<String> mediaTypes)
      Updates the existing media types with new entries that this documentation consumes
      参数:
      mediaTypes - - new media types
      返回:
      this

    • protocols

      public OperationBuilder protocols(Set<String> protocols)
      Update the protocols this operation supports
      参数:
      protocols - - protocols
      返回:
      this

    • authorizations

      public OperationBuilder authorizations(Collection<SecurityReference> securityReferences)
      Updates the security checks that apply to this operation
      参数:
      securityReferences - - authorization that reference security definitions
      返回:
      this

    • parameters

      public OperationBuilder parameters(List<Parameter> parameters)
      Updates the input parameters this operation needs
      参数:
      parameters - - input parameter definitions
      返回:
      this

    • responseMessages

      public OperationBuilder responseMessages(Set<ResponseMessage> responseMessages)
      Updates the response messages
      参数:
      responseMessages - - new response messages to be merged with existing response messages
      返回:
      this

    • deprecated

      public OperationBuilder deprecated(String deprecated)
      Marks the listing as deprecated
      参数:
      deprecated - - surely this had to be a boolean!! TODO!!
      返回:
      this

    • hidden

      public OperationBuilder hidden(boolean isHidden)
      Marks the operation as hidden
      参数:
      isHidden - - boolean flag to indicate that the operation is hidden
      返回:
      this

    • responseModel

      public OperationBuilder responseModel(ModelReference responseType)
      Updates the reference to the response model
      参数:
      responseType - = response type model reference
      返回:
      this

    • tags

      public OperationBuilder tags(Set<String> tags)
      Updates the tags that identify this operation
      参数:
      tags - - new set of tags
      返回:
      this

    • extensions

      public OperationBuilder extensions(List<VendorExtension> extensions)
      Updates the operation extensions
      参数:
      extensions - - operation extensions
      返回:
      this

    • build

      public Operation build()