AI 风格管理 API 文档
本文档描述了 AI 风格管理相关的接口规范。
1. 全局响应结构
所有接口的返回值均由 GlobalResponseWrapper 统一包装,遵循以下 JSON 结构:
{
"code": 200, // 状态码 (200: 成功, 其他: 失败)
"message": "success", // 响应消息
"success": true, // 成功标识
"data": { ... }, // 具体业务数据
"timestamp": 1709628736123 // 响应时间戳
}
2. 新增风格
- URL:
/v2/style/add
- Method:
POST
- Content-Type:
application/json
- 描述: 新增 AI 风格。
请求参数
| 字段名 |
类型 |
必填 |
说明 |
name |
string |
否 |
风格名字 |
describe |
string |
否 |
风格描述 |
author |
string |
否 |
作者 |
coverImg |
string |
否 |
风格封面,可以是一个视频封面 |
detailImg |
string |
否 |
详情图(逗号分割) |
originalStandardPlanPrice |
number |
否 |
标准定价(原价) |
originalStandardPlanPoints |
integer |
否 |
标准定价(原价)(积分) |
standardPlanPrice |
number |
否 |
标准定价 |
standardPlanPoints |
integer |
否 |
标准定价(积分) |
originalFastPlanPrice |
number |
否 |
快速套餐价格(原价) |
originalFastPlanPoints |
integer |
否 |
快速套餐价格(原价)(积分) |
fastPlanPrice |
number |
否 |
快速套餐价格 |
fastPlanPoints |
integer |
否 |
快速套餐价格(积分) |
sort |
integer |
否 |
排序 |
tagId |
string |
否 |
风格的tag(限免、上新、等) |
use |
integer |
否 |
风格的使用量 |
minPic |
integer |
否 |
风格所需最低图片数量 |
maxPic |
integer |
否 |
风格所需最高图片数量 |
fastPic |
integer |
否 |
快速套餐生成图片数量 |
standardPic |
integer |
否 |
标准套餐生成图片数量 |
templateZip |
string |
否 |
模版zip文件 |
showType |
integer |
否 |
展示类型 0:默认 |
textTitleBelowSampleImg |
string |
否 |
样图下面区域文本标题 |
textContentBelowSampleImg |
string |
否 |
样图下面区域文本内容 |
sampleImg |
string |
否 |
样图 |
detailImgMask |
string |
否 |
详情图蒙版 |
cardCoverImg |
string |
否 |
卡片模块下封面图 |
platform |
string |
否 |
平台(iOS,安卓等) |
minVersionNum |
string |
否 |
最小版本号 |
maxVersionNum |
string |
否 |
最大版本号 |
sampleImgTitle |
string |
否 |
样图标题 |
sampleImgDesc |
string |
否 |
样图描述 |
stylemode |
integer |
否 |
stylemode |
inneed |
integer |
否 |
inneed |
badge |
string |
否 |
角标 |
color |
string |
否 |
角标颜色值 |
lang |
string |
否 |
语言包 |
apiType |
integer |
否 |
ai平台(默认2) |
aiContent |
string |
否 |
api调用默认参数 |
aiType |
string |
否 |
滤镜能力 |
requirements |
string |
否 |
requirements |
styleType |
integer |
否 |
模版类型,0:可试用,1:vip |
previewImg |
string |
否 |
视频封面预览图 |
响应参数
| 字段名 |
类型 |
说明 |
data |
boolean |
是否成功 |
3. 删除风格
- URL:
/v2/style/delete/{id}
- Method:
DELETE
- 描述: 根据 ID 删除风格。
请求参数
| 字段名 |
类型 |
必填 |
说明 |
id |
integer |
是 |
风格ID |
响应参数
| 字段名 |
类型 |
说明 |
data |
boolean |
是否成功 |
4. 修改风格
- URL:
/v2/style/update
- Method:
PUT
- Content-Type:
application/json
- 描述: 修改风格信息。
请求参数
与新增风格参数一致,需包含 id 字段。
| 字段名 |
类型 |
必填 |
说明 |
id |
integer |
是 |
风格ID |
| ... |
... |
... |
其他需修改的字段 |
响应参数
| 字段名 |
类型 |
说明 |
data |
boolean |
是否成功 |
5. 获取单个风格
- URL:
/v2/style/get/{id}
- Method:
GET
- 描述: 根据 ID 获取风格详情。
请求参数
| 字段名 |
类型 |
必填 |
说明 |
id |
integer |
是 |
风格ID |
响应参数 (data 字段)
返回 TAiStyle 对象,字段详情见新增接口参数说明。
6. 分页查询风格
- URL:
/v2/style/page
- Method:
GET
- 描述: 分页查询风格,支持风格名称模糊查询。
请求参数
| 字段名 |
类型 |
必填 |
说明 |
pageNum |
integer |
是 |
页码 (默认 1) |
pageSize |
integer |
是 |
每页数量 (默认 10) |
name |
string |
否 |
风格名称 (模糊查询) |
id |
integer |
否 |
风格ID (精确查询) |
响应参数 (data 字段)
| 字段名 |
类型 |
说明 |
records |
array |
风格列表 |
total |
integer |
总记录数 |
size |
integer |
每页数量 |
current |
integer |
当前页码 |
pages |
integer |
总页数 |