Skip to content

Use API descriptors#

Operational Excellence · API Management · Azure.APIM.APIDescriptors

API Management APIs should have a display name and description.

Description#

Each API created in API Management can have a display name and description set. This information is visible within the developer portal and exported OpenAPI definitions.

Recommendation#

Consider using display name and description fields on APIs to convey intended purpose and usage. Display name and description fields should be human readable and easy to understand.


Last update: 2021-09-24