@ equinor/ 组合框架- 模块- 服务

为Fusion框架所打入的API服务客户端. 提供基于工厂的平台后端服务访问(app state,书签,上下文,通知,人),有版本端点,自动HTTP客户端解析,以及响应验证.

特征

• 域特有 API 客户端 —— 说 AppStateApiClient, (中文(简体) ), BookmarksApiClient, (中文(简体) ), ContextApiClient, (中文(简体) ), NotificationApiClient, (中文(简体) ), PeopleApiClient
• 版本终点 ——每个服务都暴露出有版本意识的方法(如. v1, (中文(简体) ), v2, (中文(简体) ), v4)带有类型安全请求/响应形状
• 双重消费模式 - 每一个终点都支持 Promise (单位:千美元)json)和可观测(json$返回类型
• 自动 HTTP 客户端解析 ——通过HTTP模块解决被命名客户端,回归服务发现
• 反应验证 ——内置响应处理器验证HTTP状态代码并抛出结构化 ApiProviderError 失败时
• Zod 计划选择器 —— 说 schemaSelector 用 Zod 计程器解析运行时响应的工具
• 书签 Zod 计划 预先建造的Zod计划ApiBookmarkSchema, (中文(简体) ), ApiBookmarkPayload用于书签实体

安装

pnpm add @equinor/fusion-framework-module-services

使用量

启用模块

在应用程序配置时注册服务模块 :

import { enableServices } from '@equinor/fusion-framework-module-services';

export const configure = (configurator) => {
  enableServices(configurator);
};

自定义客户端厂

覆盖 HTTP 客户端解析度 configureServices数字 :

import { configureServices } from '@equinor/fusion-framework-module-services';

export const configure = (configurator) => {
  configurator.addConfig(
    configureServices((cfg) => {
      cfg.createClient = async (name) => myHttpClientFactory(name);
    }),
  );
};

创建和使用 API 客户端

运行时访问服务提供商创建域客户端 :

// App State
const appState = await provider.services.createAppStateClient('json');
const apps = await appState.listMyApps('v1');
await appState.wipeMyAppState('v1', { appKey: 'my-app' });

// Bookmarks
const bookmarks = await provider.services.createBookmarksClient('json');
const allBookmarks = await bookmarks.query('v1');
const single = await bookmarks.get('v1', { bookmarkId: 'abc-123' });

// Context
const context = await provider.services.createContextClient('json');
const ctx = await context.get('v1', { id: 'context-id' });
const results = await context.query('v1', { query: 'my search' });

// Notifications
const notifications = await provider.services.createNotificationClient('json');
const all = await notifications.getAll('v1');
await notifications.setSeenByUser('v1', { notificationId: 'notif-id' });

// People
const people = await provider.services.createPeopleClient();
const person = await people.get('v4', 'json', { azureId: 'azure-unique-id' });
const photo = await people.photo('v2', 'blob', { azureId: 'azure-unique-id' });

API 参考

模块设置

提供者

域客户端

类型和公用事业

操作遥测

当遥测模块可用时, ApiProvider 记录一 fusion.services.create-client.duration 以它创建的 API 客户端为单位, 服务发现厂和定制工厂,其中一家已消毒 fusion.services.create-client.failure 无法创建客户端时除外。 服务 姓名、URI和错误从未被记录。 报告发现分辨率和HTTP尝试 由他们自己的模块.

配置

服务单元取决于:

• @equinor/fusion-framework-module-http ——提供命名的HTTP客户端
• @equinor/fusion-framework-module-service-discovery (可选)——通过服务发现自动客户端解析

当注册的HTTP客户端或服务发现无法为服务名称提供时,模块会在客户端创建过程中抛出错误.