Configuring a DataPower API Gateway proxy collector for API discovery

swagger: '2.0'
info:
  version: version
  title: title
  x-ibm-name: name
  contact:
    name: contact_name
basePath: /
x-ibm-configuration:
  properties:
    target-url:
      value: target_url
      description: url_description
      encoded: false
  cors:
    enabled: true
  gateway: datapower-api-gateway
  type: rest
  phase: realized
  enforced: true
  testable: true
  assembly:
    execute:
      - invoke:
          title: invoke
          version: 2.0.0
          verb: keep
          target-url: $(target-url)$(request.path)$(request.search)
          follow-redirects: false
          timeout: 60
          parameter-control:
            type: allowlist
            values: []
          header-control:
            type: blocklist
            values: []
          inject-proxy-headers: true
          persistent-connection: true
      - log:
          version: 2.1.0
          title: log
          log-level: default
          mode: gather-only
      - set-variable:
          version: 2.0.0
          title: set-variable
          actions:
            - set: log.custom_data.discoveryServiceCollection
              value: 'true'
              type: string
          description: Setting specific collector key
      - set-variable:
          version: 2.0.0
          title: set-variable
          actions:
            - set: log.custom_data.apiTargetURL
              value: $(target-url)
              type: string
          description: Setting specific collector target URL
    catch: []
    finally: []
  activity-log:
    enabled: true
    success-content: payload
    error-content: payload
  catalogs: {}
  buffering: true
paths:
  /{+pathparam}:
    get:
      responses:
        '200':
          description: success
          schema:
            type: string
      consumes: []
      produces: []
    post:
      responses:
        '201':
          description: success
          schema:
            type: string
      consumes: []
      produces: []
    put:
      responses:
        '201':
          description: success
          schema:
            type: string
    patch:
      responses:
        '200':
          description: success
          schema:
            type: string
      consumes: []
      produces: []
    delete:
      responses:
        '204':
          description: success
          schema:
            type: string
      consumes: []
      produces: []
    parameters:
      - name: +pathparam
        in: path
        required: true
        type: string
schemes:
  - https

Where:

• version is the version number of the API.
• title is the title of the API. For example, My proxy API.
• name is the name of the API. The value of the name field must be a single string that can be used to identify the API in commands, for example, my-proxy-api.
• contact_name is the name of a contact for the API.
• target_url is the URL endpoint of the existing REST service that you want to expose. For example, https://myorg.com/api/.
• url_description is a description of the target URL.
• $(target-url)$(request.path)$(request.search) is an invoke policy that allows wildcard paths and parameters to be passed after the target_url endpoint of the existing REST service. Suffixing the $(target-url) with $(request.path)$(request.search), means that any number (1-n) of request paths and any number (1-n) of path parameters that are invoked by the users of the API, are captured and processed by the discovery collector, regardless of them not being explicitly defined in the proxy OpenAPI schema definition.
• log is a log policy that enables a custom log to been added.
• set-variable are set-variable policies that set a specific collector key called discoveryServiceCollection, and a specific collector target URL called apiTargetURL. The collector uses the discoveryServiceCollection key to filter analytics data for events that are associated with the proxy API definition, and the apiTargetURL to filter the duplicate invokes from different data sources.
• activity-log is an activity-log policy that decides how complete the discovered OpenAPI reconstruction is. Setting both success-content and error-content fields to payload gives the collector enough data to be able to ensure that the request and response schemas can be created correctly. You can also set these fields to activity or header data, which in both cases means that less of the OpenAPI structure is discoverable. Note that the collector does not look at the payload values, and these values are redacted before being sent from the collector to the discovery capability.
• paths is set to a wild card value, for example {+pathparam}, to ensure that there is the maximum range of discoverable paths available on the proxy API. The paths.parameters section should be defined to the same value. Under the paths:/{+pathparam} property, stub methods for get, post, patch, put, and delete can be added to give maximum reach through the proxy for all of the operations that can be discovered.

You use the Request field to find your API traffic by passing the GET, POST, PATCH, PUT, and DELETE methods through the proxy API. For example:

GET https://myorg.com:9443/test/sandbox/users

Returns a list of users.

Sources can have the following status:

• Enabled - the source is enabled, and synchronizes with the collector according to its configuration.
• Disabled - the source is disabled, and API Connect won't accept any files from the collector. This status is set by the discovery service if a discovery operation fails.
• Unhealthy - the source collector is unavailable.
• Paused - the source is paused, and API Connect won't accept any files from the collector.

• Pause collector - to pause the source.
• Delete collector - to delete the source from the API Manager UI. The external source files are not deleted.
• Resume collector - to restart a paused or disabled source.