中台
    中台
    • 规范
    • 项目管理
      • 锁定状态
        • 锁定
        • 提交版本
        • 取消锁定
        • 初始化单体下专业
        • 更新项目信息
        • 更新项目扩展信息
        • 更新单体信息
        • 更新单体扩展信息
        • 添加单体
        • 添加文件版本(文件上传成功后调用)
        • 添加单体扩展信息
        • 项目详情
        • 项目扩展信息
        • 单体列表
        • 专业列表
        • 文件版本列表
        • 删除单体
      • 普通状态
        • 项目列表(带分页)
        • 项目详情
        • 单体列表
        • 项目下拉筛选项
        • 专业列表
        • 批量检查是否处于编辑状态
      • 创建项目
        POST
    • 模型管理
      • 单体下属文件列表
        POST
      • 模型详情
        POST
      • 批量删除文件或文件夹
        POST
      • 轻量化
        POST
    • 存储管理
      • 分片上传
        • 获取分片上传凭证
        • 检查分片是否存在
        • 检查分片是否存在v2
        • 文件分片上传
        • 合并分片
      • 下载
        • 单文件下载
        • 批量下载
      • 普通上传
        POST
      • 检查文件是否存在
        GET
      • 秒传
        POST
    • 任务管理
      • 任务列表
        POST
      • 任务取消
        POST
      • 任务重试
        POST
      • 更新任务读取状态
        POST
    • 能力服务
      • 模型对比-SZ-IFC
        • 模型对比-SZ-IFC
        • 开启IFC模型对比任务
        • 查询IFC模型对比任务结果
      • 轻量化展示
        • 轻量化展示
        • 获取obv-token
      • 图纸识别
        • 图纸识别
        • 识图识别任务开启
        • 识图识别结果查询
      • 图模匹配
        • 图模匹配
        • 开启图模匹配任务
        • 图模匹配任务结果查询
      • 空间计算
        • 空间计算
        • 查询空间树
        • 查询构件树
        • 查询机电系统树
        • 根据空间查构件
        • 根据构件查属性
      • 模型对比-Revit
        • 模型对比-Revit
        • 开启Revit模型对比任务
        • 查询Revit模型对比任务信息
        • 查询Revit模型对比结果
      • 项目维度统计查询
        • 项目维度统计查询
        • 项目聚合列表
        • 项目编码列表
        • 获取子文件夹树
        • 获取子文件列表
        • 项目版本列表
      • 模型维度统计查询
        • 模型维度统计查询
        • 按类型获取模型数量
        • 按周期获取模型数量
        • 按专业获取统计模型
        • 按单体获取模型列表
      • 单体维度统计查询
        • 单体维度统计查询
        • 根据项目ID获取单体
      • 能力列表
        POST
      • 能力接口列表
        POST
      • 模型文件Hash存储
        POST
      • 模型文件Hash查询
        POST

    规范

    1 接口升级#

    为了便于后期接口的升级和维护,建议在接口路径中加入版本号,便于管理,实现接口多版本的可维护性。如果你细心留意过的话,你会发现好多框架对外提供的API接口中(如:Eureka),都带有版本号的。如:接口路径中添加类似"v1"、"v2"等版本号。
    格式规范如下:
          /api/xx/v2
    更新版本后可以使用v2、v3等、依次递加。

    2 返回数据规范#

    统一规范返回数据的格式。返回数据包含:返回状态码、返回状态信息、具体数据。
    格式规范如下:
          {
    
             code: 0, // 一般0代表请求正常
    
             errmsg: "success", // code码表述
    
             data: {} | [] | string  // json格式的具体数据,可能是对象、列表、字符串数据类型
    
          }

    3 跨域#

    中台的外部接口不允许跨域访问
    修改于 2023-09-10 13:37:12
    下一页
    项目管理
    Built with