Good documentation increases the probability that consumers will use a Service correctly. The OpenAPI spec that APIM 3.0 generates when you publish provides useful information, such as HTTP method types and expected request and response formats. In Service documentation, you can add images and other details, such as the type of authorization required. This information displays to consumers when they click on the Service in the APIM 3.0 Developer Portal site to view its details. Organizing Services under categories and with tags makes it easier for consumers to find the appropriate Services.

From the Documentation tab of a Service version, you can:

• Create, edit, and delete pages, images, and text that describe how to use the Service version. Text must be in Markdown format.
• Add an image to the Service card.
• Create, edit, and delete the categories that display on the Developer Portal.
• Select one or more categories to display the Service version in.

The Documentation tab contains the following controls:

The following describe how to:

• Manage Developer Portal categories
• Select categories for a Service version
• Add or change the card image
• Manage how to use pages