@crvouga/mockingbird-service-prism (英语)

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

国家模拟器 棱镜实验室 测试套件的机身扫描 API:主题提升、扫描 创建, 预签名的抓取将抓取页面 PUT 上传到每个阶段的视频 处理状态, 和ReADY-扫描结果 我们的后端持续(身体组成, 测量、新陈代谢年龄的健康报告、资产URL)。 扫描通过真实 寿命周期(CREATED → PROCESSING → READY 编号 : FAILED命令或模拟钟,以及 计算结果要确定对象的身高、体重、性别和年龄.

• 行动范围: 支助
• 合同openapi.yaml由消费者的zod schemas手写 (单位:千美元)prism-scan.adapter.ts)和捕获页的上传(body-scan-capture-page) (中文(简体) ).

安装

npm install -D @crvouga/mockingbird-service-prism

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-prism serve, (中文(简体) ), createServer 从 ./server (节点),或 createRuntime 与 任何获取服务器.

使用量

点 PRISM_API_URL 在模拟器上(允许http)并设定 PRISM_API_KEY 给任何东西(或 把它贴上 --api-key) (中文(简体) ). 没有两者,我们的适配器报告 unavailable 永远不要叫出来.

npx mockingbird-prism serve --port 8825 --auto-advance 2000

import { createServer } from "@crvouga/mockingbird-service-prism/server"

// Test setup: a local Prism.
const server = await createServer()
const baseUrl = server.url // the app's PRISM_API_URL

// Application code: the requests it sends to Prism.
const prism = async (path: string, body?: unknown) => {
  const response = await fetch(`${baseUrl}${path}`, {
    method: body === undefined ? "GET" : "POST",
    headers: { authorization: "Bearer k", accept: "application/json;v=1", "content-type": "application/json" },
    ...(body === undefined ? {} : { body: JSON.stringify(body) }),
  })
  return (await response.json()) as Record<string, any>
}
await prism("/users", {
  token: "member-1", sex: "female", region: "north_america", birthDate: "1990-04-02",
  weight: { value: 64, unit: "kg" }, height: { value: 1.7, unit: "m" },
  researchConsent: false, termsOfService: { accepted: true, version: "1" },
})
const scan = await prism("/scans", { userToken: "member-1", deviceConfigName: "IPHONE_SCANNER", bodyfatMethod: "coco2" })
const upload = await prism(`/scans/${scan.id}/upload-url`, {})
await fetch(upload.url, { method: "PUT", body: "capture video bytes" }) // the capture page's upload

// Test control: finish processing without waiting.
await fetch(`${baseUrl}/__admin/scans/${scan.id}/advance`, {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({ to: "READY" }),
})

// Application code: the READY scan's results.
const bodyfat = await prism(`/scans/${scan.id}/bodyfat`)
// → {bodyfatMethod: "coco2", bodyfatPercentage: 29.6, leanMass: 45.07, fatMass: 18.93, …}

await server.close()

路线

所有与 Authorization: Bearer <key> 财务报告和审定财务报表 Accept: application/json;v=1,但 预签名上传和资产 URL.

ReADY 之前的结果为 404(我们的适配器: not_found) (中文(简体) ). 错误是 {message, errors?}。 。 。 .

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}: unauthorized, (中文(简体) ), server_error, (中文(简体) ), scan_not_found, (中文(简体) ), schema_drift (未知扫描状态), stage_states_slow (6s,超过5分超时), metabolic_age_missing, (中文(简体) ), metabolic_age_implausible, (中文(简体) ), upload_forbidden, (中文(简体) ), connection_drop。 。 。 .

命名空间

x-mockingbird-namespace页:1 /__admin/ns/<name> 前缀在 PRISM_API_URL,或用 API 键: PUT /__admin/credentials {"credentials": {"<PRISM_API_KEY>": "<namespace>"}}签署 上传和资产 URL 在路径中包含命名空间, 因为抓取页的 PUT 没有 其他载体.

故意不模拟

• Webhooks:我们的后端民调Prism,它没有接收器.
• 实体重建:结果为标的输入的公式和3D资产 是占位符字节.
• 扫描删除、用户列表和适配器不调用的每一个端点 .

API 密码

部分 嘲笑鸟。 。 。 .