Package com.ibm.broker.rest

  • Interface Summary 
    Interface Description
    Api
    An interface that describes an API.
    ApiKeySecurityScheme
    An interface that describes an API key security scheme in an API.
    ApiProvider
    An implementation of this interface provides methods for loading and saving the definitions of an API from a file or URL, where those definitions are stored in a API definition language supported by that implementation.
    BasicAuthSecurityScheme
    An interface that describes a basic authentication security scheme in an API.
    Model
    An interface that describes a model in an API.
    OAuth2SecurityScheme
    An interface that describes an OAuth2 security scheme in an API.
    Operation
    An interface that describes an operation in an API.
    Parameter
    An interface that describes a parameter in an API.
    Request
    An interface that describes a possible request for an operation in an API.
    Resolver
    An interface that can be implemented in order to resolve the location of API documents that are referenced by a top level API document.
    Resource
    An interface that describes a resource in an API.
    Response
    An interface that describes a possible response for an operation in an API.
    SecurityRequirement
    An interface that describes a security requirement for an API or for an operation.
    SecurityScheme
    An interface that describes a security scheme in an API.
  • Class Summary 
    Class Description
    ApiProviderFactory
    This class manages instances of classes that implement the ApiProvider interface.
    DynamicContent
    A class that defines dynamic content that can be served as supporting documentation for an API.
    StaticContent
    A class that defines static content that can be served as supporting documentation for an API.
  • Enum Summary 
    Enum Description
    DataType
    An enumeration of supported data types for parameters within an API.
    Method
    An enumeration of supported HTTP methods for operations within an API.
    OAuth2Flow
    An enumeration of supported OAuth2 flows for an OAuth2 security scheme within an API.
    ParameterType
    An enumeration of supported parameter types for parameters within an API.
    SecuritySchemeType
    An enumeration of supported security scheme types for security schemes within an API.
  • Exception Summary 
    Exception Description
    ApiException
    This exception should be thrown by all implementations of the Api interface for all errors encountered when loading API descriptions from files or URLs.