Package springfox.documentation.builders

Class ApiInfoBuilder

  • public class ApiInfoBuilder
extends java.lang.Object
    Builds the api information

    • Constructor Detail

      • ApiInfoBuilder

        public ApiInfoBuilder()

    • Method Detail

      • title

        public ApiInfoBuilder title​(java.lang.String title)
        Updates the api title
        Parameters:
        title - - title for the API
        Returns:
        this

      • description

        public ApiInfoBuilder description​(java.lang.String description)
        Updates the api description
        Parameters:
        description - - api description
        Returns:
        this

      • termsOfServiceUrl

        public ApiInfoBuilder termsOfServiceUrl​(java.lang.String termsOfServiceUrl)
        Updates the terms of service url
        Parameters:
        termsOfServiceUrl - - url to the terms of service
        Returns:
        this

      • version

        public ApiInfoBuilder version​(java.lang.String version)
        Updates the api version
        Parameters:
        version - - of the API
        Returns:
        this

      • contact

        public ApiInfoBuilder contact​(Contact contact)
        Updates contact information for the person responsible for this API
        Parameters:
        contact - - contact information
        Returns:
        this

      • license

        public ApiInfoBuilder license​(java.lang.String license)
        Updates license information for this API
        Parameters:
        license - licence string
        Returns:
        this

      • licenseUrl

        public ApiInfoBuilder licenseUrl​(java.lang.String licenseUrl)
        Updates the license Url for this API
        Parameters:
        licenseUrl - - license Url
        Returns:
        this

      • extensions

        public ApiInfoBuilder extensions​(java.util.List<VendorExtension> extensions)
        Adds extensions for this API
        Parameters:
        extensions - - extensions
        Returns:
        this