Enriching an API

You can modify the API attributes such as the API logo or icon, supporting documents, categories, and summary and description of the API resources.

About this task

Developer Portal supports providing of Markdown text and text in the supported languages for the following API attributes:

  • API summary and description
  • API categories such as tags, business terms, API grouping, and maturity status
  • API documents
  • Resource summary and description
  • Method summary and description
Note: For security reasons, add authentic and valid Markdown content.
In this example, consider adding API tags under API categories of the API, Petstore.
Note: Enriching of Async APIs is not supported.

Procedure

  1. Expand the menu options, click Manage, and click Assets.
  2. Click APIs.
  3. Click the enrich icon next to the API that you want to edit.
    For information on Markdown text, see https://www.markdownguide.org/extended-syntax/.
  4. Select API categories from the left pane and provide the new tag, Swagger and press Enter.
  5. Click Save.
    The tag is added to the API. Users can filter APIs based on tags in the API gallery page.

What to do next

You can provide or modify the following details of the API:
  • API info
  • API summary and description
  • Resource summary and description
  • Method summary and description