index.js - HTTP API文档

生成时间: 2026-01-29T15:50:55.678Z 源文件: index.js API端点数量: 18

AI建站系统 API 文档

路由分组：/rtagent/aiweb/

所有API端点均使用Express.js的app.all()方法定义，支持所有HTTP方法，并应用了urlParser和session_filter中间件。

API端点表格

每个api均须传递user_id和s_id user_id:用户ID s_id:会话ID [注意]如无user_id和s_id会报session-error错误

设计规范相关

页面生成相关

项目管理相关

中间件使用情况

所有路由都使用了以下中间件：

• urlParser: 解析请求URL
• session_filter: 会话过滤和验证

业务数据存储格式

项目数据格式 (JSON)

{
  "project_id": "aiweb_时间戳_随机字符串",
  "website_type": "网站类型(landing/ecommerce/saas等)",
  "description": "网站描述",
  "selected_pages": ["页面类型数组"],
  "design_specs": "设计规范文档内容",
  "api_calls": ["API调用URL数组"],
  "session_id": "AI会话ID",
  "created_at": "ISO时间字符串",
  "status": "项目状态(design_generated/homepage_generated等)",
  "homepage": {
    "session_id": "会话ID",
    "html_code": "HTML代码",
    "url": "分享链接",
    "navigation_url": "导航URL",
    "generated_at": "生成时间"
  },
  "pages": {
    "页面类型": {
      "name": "页面名称",
      "type": "页面类型",
      "html": "HTML代码",
      "url": "分享链接",
      "navigation_url": "导航URL",
      "session_id": "会话ID",
      "status": "状态"
    }
  },
  "custom_pages": [
    {
      "id": "自定义页面ID",
      "name": "页面名称",
      "html": "HTML代码",
      "url": "分享链接",
      "navigation_url": "导航URL",
      "session_id": "会话ID",
      "status": "状态"
    }
  ],
  "navigation_data": [
    {
      "name": "页面名称",
      "url": "页面URL",
      "type": "页面类型"
    }
  ],
  "generated_pages": [
    {
      "name": "页面名称",
      "type": "页面类型",
      "url": "分享链接",
      "html_code": "HTML代码",
      "navigation_url": "导航URL",
      "session_id": "会话ID",
      "status": "状态"
    }
  ],
  "releases": [
    {
      "id": "发布ID",
      "project_id": "项目ID",
      "app_name": "应用名称",
      "app_title": "应用标题",
      "release_time": "发布时间",
      "result": "发布结果",
      "local_time": "本地时间"
    }
  ]
}

缓存存储结构

• 存储路径：cached/aiweb/
• 文件命名：{project_id}.json
• 数据格式：上述项目数据格式的JSON序列化

页面类型映射

{
  "home": "首页",
  "about": "关于我们",
  "services": "服务/产品",
  "pricing": "定价",
  "contact": "联系我们",
  "blog": "博客"
}

项目状态流转

1. design_generated - 设计规范已生成
2. homepage_generated - 首页已生成
3. navigation_generated - 导航路径已生成
4. pages_generated - 所有页面已生成
5. published - 项目已发布

元数据

{
  "sourceFile": "index.js",
  "generatedAt": "2026-01-29T15:50:55.678Z",
  "endpointCount": 18,
  "hasHttpApis": true
}

这个Node.js版本的AI建站API封装具有以下特点：

使用的一般步骤(顺序步骤为:1-5)：

1. 设计规范生成 (/rtagent/aiweb/design/specs)

   • 根据网站类型和描述生成UI/UX设计规范
   • 调用外部API获取专业设计建议
   • 生成默认设计规范作为备选

2. 首页生成 (/rtagent/aiweb/homepage/generate)

   • 基于设计规范生成首页HTML代码
   • 使用Tailwind CSS确保响应式设计
   • 获取分享链接供预览

3. 导航路径生成 (/rtagent/aiweb/navigation/generate)

   • 生成网站导航结构
   • 支持预设页面和自定义页面
   • 生成页面URL映射

4. 其他页面生成 (/rtagent/aiweb/pages/generate)

   • 批量生成其他页面（关于、服务、定价等）
   • 支持自定义页面
   • 保持与首页一致的设计风格

5. 项目发布到服务器 (/rtagent/aiweb/project/publish)

   • 将网站发布到服务器
   • 获得返回的网站url链接

6. 项目管理

   • 项目加载
   • 项目列表查看
   • 项目导出（JSON/ZIP格式）
   • 项目发布到服务器

技术特点：

1. 复用现有架构：基于index.js中的AI Agent实现模式
2. 缓存机制：使用文件缓存存储项目数据
3. 错误处理：完善的错误处理和用户反馈
4. 会话管理：支持AI对话会话的恢复和重用
5. 模块化设计：每个功能独立封装，便于维护和扩展

使用方式：

前端可以通过HTTP请求调用这些API，实现与HTML版本相同的AI建站功能，但具有更好的性能和可扩展性。