程序包 springfox.documentation.builders

类 DocumentationBuilder

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

  • 构造器详细资料

    • DocumentationBuilder

      public DocumentationBuilder()

  • 方法详细资料

    • name

      public DocumentationBuilder name(String groupName)
      Name of the documentation group
      参数:
      groupName - - group name
      返回:
      this

    • apiListingsByResourceGroupName

      public DocumentationBuilder apiListingsByResourceGroupName(com.google.common.collect.Multimap<String,ApiListing> apiListings)
      Updates the map with new entries
      参数:
      apiListings - - entries to add to the existing documentation
      返回:
      this

    • resourceListing

      public DocumentationBuilder resourceListing(ResourceListing resourceListing)
      Updates the resource listing
      参数:
      resourceListing - - resource listing
      返回:
      this

    • tags

      public DocumentationBuilder tags(Set<Tag> tags)
      Updates the tags with new entries
      参数:
      tags - - new tags
      返回:
      this

    • produces

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

    • consumes

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

    • host

      public DocumentationBuilder host(String host)
      Updates the host (name or ip) serving this api.
      参数:
      host - - new host
      返回:
      this

    • schemes

      public DocumentationBuilder schemes(Set<String> schemes)
      Updates the schemes this api supports
      参数:
      schemes - - new schemes
      返回:
      this

    • basePath

      public DocumentationBuilder basePath(String basePath)
      Base path for this API
      参数:
      basePath - - base path
      返回:
      this

    • extensions

      public DocumentationBuilder extensions(List<VendorExtension> extensions)
      Adds extensions for this API
      参数:
      extensions - - extensions
      返回:
      this

    • byListingPosition

      public static Comparator<ApiListing> byListingPosition()

    • build

      public Documentation build()