Reviewing your discovered APIs

How to review the discovered OpenAPI documents in your API discovery capability.

Before you begin

One of the following roles is required to be able to edit discovered APIs:
  • Organization Administrator
  • Owner
  • Custom role with any of the following permissions:
    • Settings: Manage
    • Api-Drafts: Edit
A custom role with the Settings: View or Api-Drafts: View permission is able to view discovered APIs.

About this task

API discovery is an add-on to IBM® API Connect that can be used to discover and add APIs to your API development process. After a source collector is added to the API discovery capability, you can manage the discovered OpenAPI documents in API Manager.

Procedure

To manage your discovered OpenAPI documents, complete the following steps.
  1. In the API Manager UI, click the Discover icon The discover icon is the outline of a pair of binoculars in white on a black background., and then ensure that the APIs tab is selected.
  2. The list of discovered OpenAPI documents is displayed in the table. The OpenAPI documents in the list are updated according to the configuration settings on their source.
    The OpenAPI documents can have one of the following states:
    • Discovered - the OpenAPI document is discovered by the source.
    • Copied to drafts - the OpenAPI document is copied to the APIs tab in the Develop section of the API Manager UI.
  3. To view the metadata of an OpenAPI document, click the Options icon The options icon is a set of three vertical black dots on a white background. next to the document that you want to review, and select View metadata.
    A brief description of the API is displayed. You can then click View API to view the complete OpenAPI document, or click Hide API to hide the API in the list.
  4. To view the complete OpenAPI document, click the title of the document in the APIs table.

    A read-only version of the complete OpenAPI document is displayed, which you can explore in the UI. You can also download the OpenAPI document as a JSON or YAML file.

  5. To copy an OpenAPI document into a draft API, you can use one of the following methods:
    • From the list of available OpenAPI documents in the APIs tab, click the Options icon The options icon is a set of three vertical black dots on a white background. next to the document that you want to copy, and select Copy to draft.
    • From within an OpenAPI document, click Copy to draft.

    You can then click the APIs tab in the Develop section of the API Manager UI, and your copied document is shown in the list of APIs. You can now edit and manage the lifecycle of this API in API Manager; for more information, see API development checklist and Working with API definitions.

  6. Optional: You can click the Options icon The options icon is a set of three vertical black dots on a white background. next to an OpenAPI document to further manage the document. The following options are available:
    • Download - to download the API.
    • View metadata - to view a brief description of the API.
    • Copy to draft - to copy the document into a draft API.
    • Hide API - to hide the document from the list of APIs. Hidden APIs can be unhidden by clicking the Filters icon The filter icon is a funnel-shaped symbol with a wide top and a narrow bottom, selecting Hidden APIs under the Show category, and clicking Apply. You can then select the Show API option against the document that you want to display again. To see the API, you must then change the filter to clear the Hidden APIs checkbox.
    • Remove API - to remove the document from the list of APIs. If the API has been copied to drafts, the API is removed only from the list of discovered APIs; it isn't removed from list of draft APIs. A removed API can be discovered again if it still exists in the source. If you want to remove an API document from the list, and not discover it again, you can select the Hide API option.
  7. Optional: You can click the Manage columns icon The manage columns icon is an outline of a wheel in black on a white background. on the table header to change the order and view of the columns.

Results

You reviewed your discovered OpenAPI documents, and copied the required APIs to drafts to enable full API lifecycle management in API Manager.