伪造 dashboard- sdk- 节点
一个节点/ TypeScript 客户端 伪造磁盘是因为 REST API, 从其 OpenAPI 光谱中生成, 并带有 openapi 类型标记 财务报告和审定财务报表 openapi 牵引它能拯救你从 手卷 HTTP 请求并重试 API 本身 .
完整 API 参考 : https://alrayyes.github.io/forge-dashboard-sdk-node/ 页面存档备份,存于互联网档案馆
最新绿色运行的测试和覆盖报告 main数字 :
https://apis.ryankes.eu/forge-dashboard-sdk-node/reports/ 页面存档备份,存于互联网档案馆
所需资源
- 节点.js 20+或 阿宝 1.1+——任何有本地血统的人
fetch。 。 。 . - 一个正在运行的伪造板实例.
- 个人 API 代号用于此例子(见下文"认证")——
每一个终点,但
/healthz财务报告和审定财务报表/api/version需要一个.
安装
bun add @forge-dashboard/sdk-node
# or: npm install @forge-dashboard/sdk-node
替代登记册: GitHub 包件
每个版本还发布到 GitHub 套件
@alrayyes/forge-dashboard-sdk-node 同一个代码,不同的范围,
因为 GitHub 软件包的 npm 注册需要一个范围到
背书所有者而不是 forge-dashboard (原始内容存档于2012-10-12). npm org. 如果你值得的话
已经认证到 GitHub (CI 在您自己的另一个重置中, 说) 和
宁愿不持有单独的 npmjs.com 证书 仅仅安装此
一个包裹.
添加一个 .npmrc 指出 GitHub 包中的范围:
@alrayyes:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
然后安装范围命名 :
npm install @alrayyes/forge-dashboard-sdk-node
认证
有密码(WebAuthn)和 a 的伪造dashboard认证浏览器
会话 cookie, 但是它的 spec 文档是一个真正的无头选项: a
个人 API 令牌, 从仪表板自己的设置页面生成
(单位:千美元)POST /api/tokens并被派到
Authorization: Bearer <token> 在每次请求之后。 传过来
createForgeDashboardClient 或设置 FORGE_DASHBOARD_TOKEN 输入
环境:
import { createForgeDashboardClient } from "@forge-dashboard/sdk-node";
const client = createForgeDashboardClient("https://dashboard.example.com", {
token: process.env.FORGE_DASHBOARD_TOKEN,
});
任何时刻,一个符号都可以从设置中撤销;这里面什么都没有 SDK一旦消失就自动刷新.
使用量
GET /api/version 不需要任何纪念物 也是证明
客户端到达服务器。 客户端是输入的
openapi-fetch 因此,每个
操作是 client.GET(path, ...) 编号 : client.POST(path, ...)返回时
{ data, error, response }数字 :
import { createForgeDashboardClient } from "@forge-dashboard/sdk-node";
const client = createForgeDashboardClient("https://dashboard.example.com");
const { data } = await client.GET("/api/version", {});
console.log("server version:", data?.version);
获取自己的仪表板需要一个符号,并显示输入错误 处理 :
import {
ApiError,
createForgeDashboardClient,
decodeError,
} from "@forge-dashboard/sdk-node";
const client = createForgeDashboardClient("https://dashboard.example.com", {
token: process.env.FORGE_DASHBOARD_TOKEN,
});
const { data, error, response } = await client.GET("/api/dashboard", {});
if (error) {
const apiErr = decodeError(response, error);
if (apiErr instanceof ApiError && apiErr.statusCode === 401) {
throw new Error("token expired or invalid");
}
throw apiErr;
}
for (const pr of data.pullRequests) {
console.log(`${pr.repo}#${pr.number}: ${pr.title} (${pr.ci})`);
}
每一次行动都一样 client.GET编号 :client.POST/.图案.
使用 decodeError 将任何失败的回复变成
@forge-dashboard/sdk-node ApiError 统一,如上所示.
客户端重复 429 或者说 5xx 以指数反转和
jitter( 尊重服务器的许可) Retry-After),并且不再重复其他任何内容
4xx{\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}用这个 retry 选项,或交换基础 fetch
完全与 fetch 选项.
重新生成类型
见 捐款额 - 生成的种类被固定在一个 特定的伪造的活板 不应该默默地从中漂出.
捐款
见 捐款额 用于建造、测试和释放 进程.
许可证
麻省理工学院 - 客户许可,不受 伪造dashboard自己的AGPL-3.0. 页:1