程序包 springfox.documentation.builders

类 ApiListingBuilder

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

  • 构造器详细资料

    • ApiListingBuilder

      public ApiListingBuilder(com.google.common.collect.Ordering<ApiDescription> descriptionOrdering)
      Update the sorting order for api descriptions
      参数:
      descriptionOrdering - - ordering for the api descriptions

  • 方法详细资料

    • apiVersion

      public ApiListingBuilder apiVersion(String apiVersion)
      Updates the api version
      参数:
      apiVersion - - api version
      返回:
      this

    • basePath

      public ApiListingBuilder basePath(String basePath)
      Updates base path for the api listing
      参数:
      basePath - - base path
      返回:
      this

    • resourcePath

      public ApiListingBuilder resourcePath(String resourcePath)
      Updates resource path for the api listing
      参数:
      resourcePath - - resource path
      返回:
      this

    • produces

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

    • consumes

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

    • appendProduces

      public ApiListingBuilder appendProduces(List<String> produces)
      Appends to the exiting collection of supported media types this listing produces
      参数:
      produces - - new media types
      返回:
      this

    • appendConsumes

      public ApiListingBuilder appendConsumes(List<String> consumes)
      Appends to the exiting collection of supported media types this listing consumes
      参数:
      consumes - - new media types
      返回:
      this

    • host

      public ApiListingBuilder host(String host)
      Updates the host
      参数:
      host - - new host
      返回:
      this

    • protocols

      public ApiListingBuilder protocols(Set<String> protocols)
      Appends to the exiting collection of supported protocols
      参数:
      protocols - - new protocols
      返回:
      this

    • securityReferences

      public ApiListingBuilder securityReferences(List<SecurityReference> securityReferences)
      Updates the references to the security definitions
      参数:
      securityReferences - - security definition references
      返回:
      this

    • apis

      public ApiListingBuilder apis(List<ApiDescription> apis)
      Updates the apis
      参数:
      apis - - apis
      返回:
      this

    • models

      public ApiListingBuilder models(Map<String,Model> models)
      Adds to the models collection
      参数:
      models - - model entries by name
      返回:
      this

    • description

      public ApiListingBuilder description(String description)
      Updates the description
      参数:
      description - - description of the api listing
      返回:
      this

    • position

      public ApiListingBuilder position(int position)
      Updates the position of the listing
      参数:
      position - - position used to for sorting the listings
      返回:
      this

    • tagNames

      public ApiListingBuilder tagNames(Set<String> tagNames)
      Updates the tags
      参数:
      tagNames - - just the tag names
      返回:
      this

    • tags

      public ApiListingBuilder tags(Set<Tag> tags)
      Updates the tags.
      参数:
      tags - - Tag with name and description
      返回:
      - this BREAKING Change in 2.4.0

    • availableTags

      public ApiListingBuilder availableTags(Set<Tag> availableTags)
      Globally configured tags
      参数:
      availableTags - - tags available for services and operations
      返回:
      this

    • build

      public ApiListing build()