@ 模拟器/ vercel

Fully stateful Vercel API 与 Vercel 风格的 JSON 响应和以光标为基础的 pagination相仿.

部分 模拟 ——为CI和无网络沙盒提供本地出入口替换服务.

安装

npm install @emulators/vercel

终点

用户团队( T)

• GET /v2/user ——认证用户
• PATCH /v2/user — 更新用户
• GET /v2/teams · 名单小组(cursor pagized)
• GET /v2/teams/:teamId - (通过身份证或子弹)
• POST /v2/teams ——创建团队
• PATCH /v2/teams/:teamId - 更新小组
• GET /v2/teams/:teamId/members - 名单成员
• POST /v2/teams/:teamId/members 增加成员

项目

• POST /v11/projects ——创建项目(带有可选的env vars和git集成)
• GET /v10/projects ——列表项目(搜索,光标页)
• GET /v9/projects/:idOrName - 获得项目(包括inv vars)
• PATCH /v9/projects/:idOrName - 更新项目
• DELETE /v9/projects/:idOrName - 删除项目(cascades)
• GET /v1/projects/:projectId/promote/aliases - 促进别名地位
• PATCH /v1/projects/:idOrName/protection-bypass 管理绕行秘密

部署

• POST /v13/deployments 建立部署(自动过渡至准备阶段)
• GET /v13/deployments/:idOrUrl ——得到部署(通过ID或URL)
• GET /v6/deployments 列表部署(按项目、目标、状态过滤)
• GET /v7/deployments 列表部署(按项目、目标、状态、承诺的过滤器)
• DELETE /v13/deployments/:id - 删除部署(连带)
• PATCH /v12/deployments/:id/cancel ——取消大楼部署
• GET /v2/deployments/:id/aliases - 清单部署别名
• GET /v3/deployments/:idOrUrl/events ——搞好活动/日志
• GET /v6/deployments/:id/files ——列表部署文件
• POST /v2/files ——上传文件(由 SHA 文摘出)

域数

• POST /v10/projects/:idOrName/domains ——新增域名(含核查质疑)
• GET /v9/projects/:idOrName/domains 列表域
• GET /v9/projects/:idOrName/domains/:domain ——获得域名
• PATCH /v9/projects/:idOrName/domains/:domain ——更新域名
• DELETE /v9/projects/:idOrName/domains/:domain — 删除域
• POST /v9/projects/:idOrName/domains/:domain/verify ——验证域

环境变量

• GET /v10/projects/:idOrName/env — list env vars (带有解密选项)
• POST /v10/projects/:idOrName/env ——创建env vars(单,批,上)
• GET /v10/projects/:idOrName/env/:id - 获取env var
• PATCH /v9/projects/:idOrName/env/:id - 最新版本 var
• DELETE /v9/projects/:idOrName/env/:id - 删除env var

认证

所有终点都接受 teamId 或者说 slug 查询团队范围界定的参数。 以光标为基础的 Pagination limit编号 :since编号 :until 与 pagination 响应对象.

种子配置

vercel:
  users:
    - username: developer
      name: Developer
      email: [email protected]
  teams:
    - slug: my-team
      name: My Team
  projects:
    - name: my-app
      team: my-team
      framework: nextjs
  integrations:
    - client_id: "oac_abc123"
      client_secret: "secret_abc123"
      name: "My Vercel App"
      redirect_uris:
        - "http://localhost:3000/api/auth/callback/vercel"

链接

• 完整文档
• GitHub 图像