APIs Management

Managing APIs consists of creating and publishing APIs and operations for the portal users to browse and test the APIs.

The portal administrator first creates one or more APIs, which are then associated with products. When creating the APIs, the portal administrator specifies the following information:

  • The type of API, that is, REST or SOAP.
  • The environments in which the APIs are usable; the APIs must be provisioned in the selected environments.
  • Any specification artifacts used by the API Swagger specifications for REST APIs or WSDL specifications for SOAP APIs. Ensure that the specification artifacts are available for upload.
    Note: The REST API resource paths specified must be unique for a product.

    If you are using Adapter Code for TIBCO API Exchange and Joomla! 2.2.0, specifying duplicate resource paths might result in the swagger specifications being displayed incorrectly in the API explorer.

  • Downloadable documentation.
  • Available inline documentation.