反应 CCM 服务客户端
OpenAPI - > OA
类型脚本 - > TS 翻译
OpenAPI + TypeScript - > 业务
这个反应 API 客户端存储了 Harness CCM (Cloud Cost Management) 服务 API 和 接口合同的集合 OATS CLI。API被暴露为基于 @tanstack/react-query。 。 。 .
构建
yarn build
初始化客户端
在使用任何钩之前, 初始化 CCMServiceAPIClient 使用您的认证和 URL 配置 :
import { CCMServiceAPIClient } from '@harnessio/react-ccm-service-client';
new CCMServiceAPIClient({
urlInterceptor: (url) => `${window.apiUrl}/${url}`,
getRequestHeaders: () => ({
Authorization: `Bearer ${yourToken}`,
'Harness-Account': accountId,
}),
requestInterceptor: (request) => {
// optionally modify the Request object before it is sent
return request;
},
responseInterceptor: (res) => {
if (res.status === 401) {
window.dispatchEvent(new CustomEvent('PROMISE_API_RESPONSE', { detail: { response: res } }));
}
return res;
},
});
运行时更新信头
客户事件曝光 updateHeaders 以在初始化后补丁标题( 如在符号刷新后) :
const client = new CCMServiceAPIClient({ ... })
// later, when the token changes:
client.updateHeaders({ Authorization: `Bearer ${newToken}` })
CCM 一体化
CCM 用户界面 restful-react 今时. 要采用此软件包, 您需要三次修改 :
| 变动 | 何处 | 需求 |
|---|---|---|
yarn add @tanstack/react-query | 《集束弹药公约》 package.json | 是——对同伴的依赖 |
环绕应用 <QueryClientProvider> | App.tsx 或者说 bootstrap.tsx | 是的,没有它钩是行不通的 |
打电话 new CCMServiceAPIClient(...) | App init/ 拖带 | 是的,如不打电话,采集者会扔出 |
最小拖带示例
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { CCMServiceAPIClient } from '@harnessio/react-ccm-service-client';
new CCMServiceAPIClient({
urlInterceptor: (url) => `${window.apiUrl}/${url}`,
getRequestHeaders: () => ({ Authorization: `Bearer ${token}`, 'Harness-Account': accountId }),
responseInterceptor: (res) => {
window.dispatchEvent(new CustomEvent('PROMISE_API_RESPONSE', { detail: { response: res } }));
return res;
},
});
const queryClient = new QueryClient();
export default function Root() {
return (
<QueryClientProvider client={queryClient}>
<App />
</QueryClientProvider>
);
}
地方发展与雅尔克
使用 雅尔克语 在发布前测试 CCM UI 的本地变化 .
第1步——建设并发布到当地的雅尔克商店:
cd packages/ccm-service
yarn build
yalc publish
步骤2——加入《集束弹药公约》
cd /path/to/ccm-ui
yalc add @harnessio/react-ccm-service-client
yarn install
yarn add @tanstack/react-query # if not already present
步骤3——重建后同步:
# in packages/ccm-service:
yarn build && yalc push
完成时删除雅尔克链接 :
cd /path/to/ccm-ui
yalc remove @harnessio/react-ccm-service-client
yarn install
版本
版本由OpenAPI spec驱动. 不手工编辑文件 src/services/ - 运行 yarn generate 更新后 openapi.json。 。 。 .