热更新解决方案

根据项目中的服务文件，我将API接口按功能模块进行了分类整理。以下是各模块的接口详情：

1. 公共接口 (common-service.ts)

获取枚举字段

function getFieldEnum(params: { code: string }): Promise<any>

• URL: /operation-manager/object/field/enum/metadata/listFieldEnumValue
• 参数:
  • code: string - 枚举字段代码
• 返回: 枚举值列表

单图上传

function postSingleImgUpload(file: File)

• URL: /resource/management/file/upload
• 参数:
  • file: File - 图片文件对象
• 返回: 上传结果，包含图片URL等信息

分类树形结构

function postCategoryList(params: Record<string, any>)

• URL: /boMenuApi/gql/category/list
• 参数: 分类查询参数
• 返回: 分类树形结构数据

获取菜单分类分组

function getMenuCategory(params = { isArchived: false }): Promise<any>

• URL: /boMenuApi/api/menu/tree
• 参数:
  • isArchived: boolean - 是否包含归档项，默认false
• 返回: 菜单分类树

查询业务配置

function queryBizConfig(params?: any, config?: any): Promise<any>

• URL: /vulcan/special/queryConfig
• 参数: 配置查询参数
• 返回: 业务配置信息

发布菜单

function publishMenu(params: any, config?: any): Promise<any>

• URL: /boMenuApi/bo-menu/api/publish-tool/addPos
• 参数: 发布相关参数
• 返回: 发布结果

新增商品规格类型

function postItemSizeAdd(params: Record<string, any> = {})

• URL: /boMenuApi/api/item/size/add
• 参数: 规格类型信息
• 返回: 新增结果

AI识别图片上传

function postFilesUpload(params: any, config?: any)

• URL: /boMenuApi/api/item/proxy/starship-upload
• 参数: 上传相关参数
• 返回: 上传结果

获取商户信息

function getCorporationInfo(params: any = {}): Promise<any>

• URL: /boShopApi/api/corporation/corporationInfo
• 参数: 查询参数
• 返回: 商户信息

2. 门店管理接口 (store/service.ts)

查询门店

function queryStore(params: { dataId: string }): Promise<Response<StoreInfo | null>>

• URL: /boShopApi/api/shop/query
• 参数:
  • dataId: string - 门店ID（必填）
• 返回: 门店信息对象

更新门店

function updateStore(params: UpdateStoreInfoParams): Promise<Response<any>>

• URL: /boShopApi/api/shop/update
• 参数: 门店信息更新对象
• 返回: 更新结果

批量保存或更新语言

function batchSaveOrUpdateLanguage(params: BatchSaveOrUpdateLanguageParams): Promise<Response<null>>

• URL: /operation-manager/content/language/batchSaveOrUpdate
• 参数: 语言批量更新参数
• 返回: 更新结果

获取语言内容

function getContentLanguage(params: { domain: string; resource: string; key: string }): Promise<Response<null>>

• URL: /operation-manager/content/language/getContentLanguage
• 参数:
  • domain: string - 域名
  • resource: string - 资源名
  • key: string - 键名
• 返回: 语言内容

自动生成门店编码

function generateStoreCode(params: { corporationId: string; orgType: string }): Promise<Response<string>>

• URL: /organize/generateOrgCode
• 参数:
  • corporationId: string - 公司ID
  • orgType: string - 组织类型
• 返回: 生成的门店编码

查询员工列表

function queryEmployeeList(params: QueryEmployeeListParams): Promise<Response<Employee[]>>

• URL: /vulcan/employee/queryEmployeeByCodes
• 参数: 员工查询参数
• 返回: 员工列表

其他查询接口

接口名	URL	参数	返回
查询语言列表	/operation-manager/dictionary/listLanguage	分页参数	语言列表
查询品牌列表	/organize/queryBrandList	corporationId: string	品牌列表
查询货币列表	/operation-manager/dictionary/listCurrency	分页参数	货币列表
获取日期格式列表	/operation-manager/format/listDataFormatAll	分页参数	日期格式列表
获取时间格式列表	/operation-manager/format/listTimeFormatAll	分页参数	时间格式列表
获取数字格式列表	/operation-manager/format/listNumberFormat	分页参数	数字格式列表
获取电话格式列表	/operation-manager/format/listPhoneFormatAll	countryCode: string	电话格式列表
获取时区列表	/operation-manager/dictionary/listTimeZone	国家代码列表和归档状态	时区列表
查询国家列表	/operation-manager/dictionary/listCountry	languageCode: string	国家列表
查询区域	/operation-manager/dictionary/listArea	国家代码、语言代码等	区域列表
查询地址格式	/operation-manager/format/listAddressFormatAll	countryCode: string	地址格式列表

地图相关接口

// 搜索地点
function searchLocation(params: { address: string }): Promise<Response<any>>
// 经纬度取位置信息
function getLocationInfo(params: { latitude: string; longitude: string }): Promise<Response<any>>

3. 桌台管理接口 (table/service.ts)

桌台相关接口

接口名	URL	参数	返回
查询桌台	/boShopApi/api/table/listTable	区域ID、分页参数等	桌台列表
新增桌台	/boShopApi/api/table/createTable	桌台信息对象	添加结果
修改桌台	/boShopApi/api/table/updateTable	桌台信息对象	更新结果
删除桌台	/boShopApi/api/table/deleteTable	tableId: string	删除结果
查询单桌台	/boShopApi/api/table/queryTable	tableId: string	桌台详情
排序桌台	/boShopApi/api/table/tableSort	桌台排序数组	排序结果
批量新增桌台	/boShopApi/api/table/batchInsertTable	批量桌台参数	批量添加结果
批量删除桌台	/boShopApi/api/table/batchDeleteTable	桌台ID数组	批量删除结果
批量修改桌台	/boShopApi/api/table/batchUpdateTable	批量桌台参数	批量更新结果

区域相关接口

接口名	URL	参数	返回
查询区域	/boShopApi/api/area/queryArea	areaId: string	区域详情
新增区域	/boShopApi/api/area/createArea	区域信息对象	添加结果
修改区域	/boShopApi/api/area/updateArea	区域信息对象	更新结果
获取区域列表	/boShopApi/api/area/listArea	归档状态	区域列表
排序区域	/boShopApi/api/area/areaSort	区域排序数组	排序结果
删除区域	/boShopApi/api/area/deleteArea	areaId: string	删除结果

其他桌台管理接口

接口名	URL	参数	返回
查询（处理服务费）	/boMenuApi/surcharge/queryPage	归档状态、服务费类型、分页参数	服务费列表
发布桌台	/boShopApi/api/area/publish	无	发布结果

4. 菜单管理接口 (menus/service.ts)

菜单相关接口

接口名	URL	参数	返回
查询菜单列表	/boMenuApi/api/menu/tree	归档状态、菜单渠道	菜单树结构
添加菜单	/boMenuApi/api/menu/add	菜单信息对象	添加结果
修改菜单	/boMenuApi/api/menu/update	菜单信息对象	更新结果
查询菜单	/boMenuApi/api/menu/query	dataId: string	菜单详情
菜单排序	/boMenuApi/api/menu/set/sequence	中心菜单UID、排序信息	排序结果
获取价格带	/boMenuApi/api/pricing/all	查询参数	价格带列表

菜单分组相关接口

接口名	URL	参数	返回
创建菜单分组	/boMenuApi/api/menu/group/add	菜单分组信息	添加结果
更新菜单分组	/boMenuApi/api/menu/group/update	菜单分组信息	更新结果
获取菜单分组详情	/boMenuApi/api/menu/group/query	查询参数	菜单分组详情

5. 商品分类接口 (categories/service.tsx)

分类相关接口

接口名	URL	参数	返回
获取商品分类列表	/boMenuApi/gql/category/list	分类级别类型、归档状态	分类列表
获取商品分类详情	/boMenuApi/gql/category/v2/getOne	dataId: string	分类详情
新增分类	/boMenuApi/gql/category/add	分类信息	添加结果
编辑分类	/boMenuApi/gql/category/update	分类信息	更新结果

其他相关接口

接口名	URL	参数	返回
查询备餐站列表	/boShopApi/api/prep/station/shop/listPage	分页参数、归档状态	备餐站列表
查询税率列表	/boMenuApi/api/tax/queryPage	分页参数、归档状态	税率列表
查询科目名称	/boShopApi/api/financial/account/list	查询参数	科目列表
查询课程列表	/boMenuApi/api/course/list	归档状态	课程列表

6. 通用功能接口 (commons/service.ts)

图片处理接口

接口名	URL	参数	返回
批量裁剪图片	/resource/management/image/space/shearImageBatch	图片裁剪数据	裁剪结果
上传图片	/resource/management/file/upload	图片文件	上传结果

7. 接口返回数据结构

大部分接口的返回数据遵循以下通用结构：

// 基本响应结构
type Response<T> = {
  code: string;       // 响应码，000表示成功
  message: string;    // 响应消息
  data: T;            // 响应数据，具体类型由接口定义
}

// 带分页的响应结构
type ResponseWithPager<T> = {
  code: string;
  message: string;
  data: {
    list: T[];        // 数据列表
    page: PageInfo;   // 分页信息
  };
}

// 分页信息
type PageInfo = {
  total: number;      // 总记录数
  pageNo: number;     // 当前页码
  pageSize: number;   // 每页大小
  pageCount: number;  // 总页数
}

以上是项目中所有主要API接口的汇总信息，包含了接口的分类、功能、请求参数和返回数据结构。

微信公众号