程序包 springfox.documentation.builders

类 ApiDescriptionBuilder

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

  • 构造器详细资料

    • ApiDescriptionBuilder

      public ApiDescriptionBuilder(com.google.common.collect.Ordering<Operation> operationOrdering)

  • 方法详细资料

    • path

      public ApiDescriptionBuilder path(String path)
      Updates the path to the api operation
      参数:
      path - - operation path
      返回:
      this @see springfox.documentation.builders.ApiDescriptionBuilder

    • description

      public ApiDescriptionBuilder description(String description)
      Updates the descriptions to the api operation
      参数:
      description - - operation description
      返回:
      this @see springfox.documentation.builders.ApiDescriptionBuilder

    • operations

      public ApiDescriptionBuilder operations(List<Operation> operations)
      Updates the operations to the api operation
      参数:
      operations - - operations for each of the http methods for that path
      返回:
      this @see springfox.documentation.builders.ApiDescriptionBuilder

    • hidden

      public ApiDescriptionBuilder hidden(boolean hidden)
      Marks the operation as hidden
      参数:
      hidden - - operation path
      返回:
      this @see springfox.documentation.builders.ApiDescriptionBuilder

    • pathDecorator

      public ApiDescriptionBuilder pathDecorator(com.google.common.base.Function<String,String> pathDecorator)

    • groupName

      public ApiDescriptionBuilder groupName(String groupName)
      Updates the group name the api operation belongs to
      参数:
      groupName - - group this api description belongs to
      返回:
      this @see springfox.documentation.builders.ApiDescriptionBuilder
      从以下版本开始:
      2.8.1

    • build

      public ApiDescription build()