Backstage解析API组件definition元素时抛出TypeError错误求助

问题场景 #

处理以下API组件时出现验证错误：

apiVersion: backstage.io/v1alpha1
kind: API
metadata:
   name: angry-cats-api
  description: Lethal cats here
spec:
  type: openapi
  lifecycle: production
  owner: user:guest
  definition:
    $yaml: https://github.com/anywhereinfo/openapi/blob/main/angrycats.yml

错误信息 #

BuiltinKindsEntityProcessor 在验证实体 api:default/angry-cats-api 时抛出错误；触发原因：TypeError: /spec/definition must be string - type: string
at DefaultLocationService.processEntities

解决方法 #

• 错误原因：spec.definition字段在Backstage的API实体规范中要求为字符串类型，但当前配置写成了嵌套的$yaml对象结构，不符合格式要求。
• 修正方案：直接将OpenAPI定义的URL作为字符串赋值给definition字段，同时修正metadata下description的缩进问题（原YAML缩进不一致会引发解析异常）：

apiVersion: backstage.io/v1alpha1
kind: API
metadata:
  name: angry-cats-api
  description: Lethal cats here
spec:
  type: openapi
  lifecycle: production
  owner: user:guest
  definition: https://github.com/anywhereinfo/openapi/blob/main/angrycats.yml

内容的提问来源于stack exchange，提问作者Jimm