使用 x-pathalias 为产品和 API 提供一致的 URL

您可以使用 x-pathalias 向产品或 API 分配 URL。

产品或 API 的 YAML 表示的信息部分可包含 x-pathalias。 此选项很有用,因为它支持在产品的不同修订版上使用相同的 URL。 它还支持使用虚 URL,这可以更好地展示站点的品牌形象,或者使 URL 更便于发音。

在此示例中,您在产品 Weather watch 中设置一个名为 Climbing weather API 的 API,以获取以下 URL:portalURL/product/weather/api/climbing

产品信息:
info:
  version: 1.0.0
  title: Weather watch
  name: weather-watch    
  x-pathalias: weather
    
API 信息:
info:
  title: Climbing Weather API  
  x-ibm-name: climbing-weather-api
  version: 1.0.0
  x-pathalias: climbing