Using x-pathalias
to give consistent URLs for products and
APIs
You can use x-pathalias
to assign a URL to a product or an
API.
The information section of a YAML representation of a Product or API can include
x-pathalias
. This option can be useful as it allows the same URL to be used on
different revisions of your product. It also allows the use of a vanity URL, which might better
represent the branding of your site, or make the URL easier to pronounce.
In this example, you set an API called Climbing weather API in product
Weather watch to have a URL of
portalURL/product/weather/api/climbing
.
Product information:
info:
version: 1.0.0
title: Weather watch
name: weather-watch
x-pathalias: weather
API
information:
info:
title: Climbing Weather API
x-ibm-name: climbing-weather-api
version: 1.0.0
x-pathalias: climbing