Declare dependencies

This page applies to Apigee and Apigee hybrid.

The following panes appear at the bottom of the API Overview page and provide links to indicate information related to the API:

  • Related: Miscellaneous information related to the API
  • Dependencies: Any dependencies of the API that may be relevant, including internal APIs, external third-party APIs, and other production systems
Dependencies, click for larger image

You can define multiple sections or types of related links. These types are backed by a system taxonomy which can be modified to allow for flexibility in the organizational structure. A special taxonomy element is defined by the system that allows you to specify only internal API dependencies, which enables the system to infer the API dependency relationships throughout API hub.

The Related pane displays links to miscellaneous information related to the API. For example, source code repository, design documentation, or infrastructure systems.

All information in the Related pane is manually defined. You can add, edit, delete, and order Related information.

To add items to the Related pane:

  1. In the Google Cloud console, go to the API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. In the Related pane, click Edit.
  4. Specify the following:
    • Source code:
      1. Click Add source code.
      2. Specify a Name.
      3. Specify a URL.
    • Example Organization APIs:

      1. Click Add Example Organization API.
      2. Select an API from the list.
    • Other:
      1. Click Add other.
      2. Specify an API Name.
      3. Specify a URL to use for API calls.
  5. Click Save (or Cancel).

To edit items in the Related pane:

  1. In the Cloud console, go to the API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. In the Related pane, click Edit.
  4. Make modifications as necessary.
  5. Click Save (or Cancel).

To delete items from the Related pane:

  1. In the Cloud console, go to the API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. In the Related pane, click Edit.
  4. Click Delete next to the desired item.
  5. Click Delete (or Cancel) in the confirmation dialog.
  6. Click Save (or Cancel).

To order items in the Related pane:

  1. In the Cloud console, go to the API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. In the Related pane, click Edit.
  4. Click Move down or Move up next to the desired item.
  5. Click Save (or Cancel).

Dependencies

The Dependencies pane lists all dependencies of the API, including other internal APIs (present in API hub), external third-party APIs (not present in API hub), and other production systems (for example, databases and storage solutions).

All information in the Dependencies pane is manually defined. You can add, edit, delete, and order Dependencies.

Add Dependency

To add to the Dependencies pane:

  1. In the Cloud console, go to the API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. In the Dependencies pane, click Edit.
  4. Specify the following:
    • Example Organization APIs:

      1. Click Add example organization API.
      2. Select an API from the list.
    • 3rd party APIs:
      1. Click Add 3rd party APIs.
      2. Specify an API Name.
      3. Specify a URL to use for API calls.
    • Other:
      1. Click Add other.
      2. Specify an API Name.
      3. Specify a URL to use for API calls.
  5. Click Save (or Cancel).

Edit Dependency

To edit the Dependencies pane:

  1. In the Cloud console, go to the API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. In the Dependencies pane, click Edit.
  4. Make any necessary modifications.
  5. Click Save (or Cancel).

Delete Dependency

To delete an item from the Dependencies pane:

  1. In the Cloud console, go to the API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. In the Dependencies pane, click Edit.
  4. Click Delete next to the desired item.
  5. Click Delete (or Cancel) in the confirmation dialog.
  6. Click Save (or Cancel).

Order Dependencies

To order items in the Dependencies pane:

  1. In the Cloud console, go to the API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. In the Dependencies pane, click Edit.
  4. Click Move down or Move up next to the desired item.
  5. Click Save (or Cancel).