Skip to content

项目 UI 生成 API

为项目生成、编辑、导入和本地化 UI 设计稿,并读取 screen 与缩略图列表。

基础信息

  • 基础路径/projects/:projectId/ui
  • 认证方式:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。

端点

补充端点

本节补充 plans/need-update-api.md 中尚未覆盖到 docs-site 的接口。端点标题保持严格的 METHOD /path 格式,便于后台文档覆盖率服务识别。

POST /projects/:projectId/ui/edit

AI 编辑 UI 界面

认证:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。 路径参数

参数说明
projectId项目 ID

请求:请求体为 JSON,包含创建、提交、安装、发布或业务动作所需字段。

响应:成功时返回创建或更新后的资源对象,或 { "success": true }

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


POST /projects/:projectId/ui/generate

AI 生成 UI 界面

认证:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。 路径参数

参数说明
projectId项目 ID

请求:请求体为 JSON,包含创建、提交、安装、发布或业务动作所需字段。

响应:成功时返回创建或更新后的资源对象,或 { "success": true }

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


POST /projects/:projectId/ui/import

导入设计稿(Stitch)

认证:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。 路径参数

参数说明
projectId项目 ID

请求:请求体按业务使用 multipart/form-data 或 JSON;上传文件时字段名以对应前端调用为准。

响应:成功时返回创建或更新后的资源对象,或 { "success": true }

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


POST /projects/:projectId/ui/import-all

批量导入 Screens

认证:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。 路径参数

参数说明
projectId项目 ID

请求:请求体按业务使用 multipart/form-data 或 JSON;上传文件时字段名以对应前端调用为准。

响应:成功时返回创建或更新后的资源对象,或 { "success": true }

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


POST /projects/:projectId/ui/import-html

HTML 直接导入 UI 设计稿

认证:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。 路径参数

参数说明
projectId项目 ID

请求:请求体按业务使用 multipart/form-data 或 JSON;上传文件时字段名以对应前端调用为准。

响应:成功时返回创建或更新后的资源对象,或 { "success": true }

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


GET /projects/:projectId/ui/list-screens

列出 Screen 列表

认证:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。 路径参数

参数说明
projectId项目 ID

请求:无请求体。Query 参数用于分页、过滤、搜索或状态筛选;未传时按后端默认排序与分页返回。

响应:成功时返回列表数据,通常包含 items / data / rows 与分页或统计字段。

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


POST /projects/:projectId/ui/screenshots/localize

截图本地化

认证:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。 路径参数

参数说明
projectId项目 ID

请求:请求体为 JSON,包含创建、提交、安装、发布或业务动作所需字段。

响应:成功时返回创建或更新后的资源对象,或 { "success": true }

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


GET /projects/:projectId/ui/thumbnails

UI 缩略图列表

认证:JWT Bearer Token 或 API Key(combinedAuth)。写入类操作需要项目写权限。 路径参数

参数说明
projectId项目 ID

请求:无请求体。Query 参数用于分页、过滤、搜索或状态筛选;未传时按后端默认排序与分页返回。

响应:成功时返回列表数据,通常包含 items / data / rows 与分页或统计字段。

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500

AI Workflow Editor