在Backstage中配置和使用Api与Dependencies

在Backstage中配置和使用Api与Dependencies

Zave Genshin Impact
  2026-10-05 12:00 2026-10-05 12:00 创建   2026-10-05 12:00 2026-10-05 12:00 更新      712 字  3 分钟  

注意
本文档基于 Backstage 1.32.0 版本编写，并采用自 1.24.0 版本以来官方推荐使用的新后端系统（New BackEnd System）。Backstage 仍处于不断更新发展中，本文下述步骤可能将不适用于后续更新版本。

一、开发前准备

  1. 确保至少已经完成了 GitLab 的集成；若未完成本部分工作，请参考此文档：在Backstage中集成GitLab
  2. 开发参考文档：

二、Api 模块的开发

（1）创建 API 注册模板

在 examples/template/content 文件夹下新建一个文件夹 apis，用于存放 API 注册模板。并新建两个文件 example-grpc.yaml 和 example-openapi.yaml，分别用于给出注册 grpc 格式的 API 文档和 openapi（swagger）格式的 API 文档的模板。

examples/template/content/apis/example-grpc.yaml：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
apiVersion: backstage.io/v1alpha1
kind: API
metadata:
  name: example-grpc-api
spec:
  type: grpc
  lifecycle: experimental
  # there are three options in lifecycle: production  experimental  deprecated
  owner: user:development/guest
  system: user:development/guest
  definition: |
    syntax = "proto3";
    service Exampler {
      rpc Example (ExampleMessage) returns (ExampleMessage) {};
    }
    message ExampleMessage {
      string example = 1;
    };

examples/template/content/apis/example-openapi.yaml：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
apiVersion: backstage.io/v1alpha1
kind: API
metadata:
  name: example-api-name
  description: an example api yaml file, can help you write your own api yaml file
spec:
  type: openapi
  lifecycle: production
  # there are three options in lifecycle: production  experimental  deprecated
  owner: user:development/guest
  system: user:development/guest
  definition: |
    openapi: "3.0.0"
    info:
      version: V1.0.0
      title: Example API
      license:
        name: MIT
    servers:
      - url: http://backstage-api.xxxxxx.com.cn/v1
    paths:
      /getUserList:
        get:
          summary: get All UserList

那么在创建好项目后，这两个文件都会出现在项目初始化文件中。

（2）注册 API 模板

开发人员需要按照给出的这两个模板，在本项目中（或者其他任何项目中）新建一个 yaml 文件，复制相应格式的模板内容，修改为自己所要注册的 API 的内容，保存并提交到项目仓库中。

然后返回 Backstage 系统，点击 APIs 菜单栏，点击 REGISTER EXISTING API 按钮，再依次执行下面的步骤：

完成注册后便能够在 APIs 列表中看到刚刚注册好的 API。以 openapi 格式为例，呈现的样子如图所示：

三、配置 API 和 Dependencies

（1）编写配置

在 examples/template/content/catalog-info.yaml 文件中添加如下配置：

1
2
3
4
5
6
7
8
9
10
11
12
spec:
  type: service
  owner: guest
  lifecycle: experimental
  consumesApis: # 本项目使用到的API
    - example-grpc-api # 编写示例
  providesApis: # 本项目对外提供的API
    - example-grpc-api # 编写示例
  dependsOn: # 本项目依赖的资源
    - resource:example-website # 编写示例
  dependencyOf: # 本项目依赖的组件
    - component:example-website # 编写示例

其中的 example-grpc-api 以及 example-website 分别是其对应的 API 和 Catalog 的名称。

当需要新增 API 或 Catalog 依赖时，就需要在项目的 GitLab 仓库的 catalog-info.yaml 文件中自行新增。

最终的效果如图所示：

至此，API 和 Dependencies 的集成也完成了。

  • 标题: 在Backstage中配置和使用Api与Dependencies
  • 作者: Zave
  • 创建于 : 2026-10-05 12:00:00
  • 更新于 : 2026-10-05 12:00:00
  • 链接: https://zavex.cn/post/41397.html
  • 版权声明: 版权所有 © Zave，禁止转载。
评论