Appearance
内容
MODULE_NAME | MODULE_DESC | 入参 | 返参 | 路径 |
---|---|---|---|---|
cms_article_list | 文章列表 | CmsArListParams | CmsArListResp | cms/article/lists |
cms_article_detail | 文章详情 | CmsArDetailParams | CmsArDetailResp | cms/article/info |
cms_channel_list | 栏目列表 | CmsChListParams | CmsChListResp | cms/channel/lists |
cms_channel_detail | 栏目详情 | CmsChDetailParams | CmsChDetailResp | cms/channelapi/info |
文章列表
CmsArListParams 类型
ts
interface CMS_AR_LIST_PARAMS {
start: number; // 游标,0开始
length: number; // 分页量,默认10
channel_id: string; // 指定栏目,多个使用使用英文逗号拼接
search_keywords: string; // 关键字搜索
show_access: number; // 是否显示权限 0不校验 1展示是否有权限 2只展示有权限数据
}
参数名 | 参数描述 | 类型 | 是否必填 |
---|---|---|---|
start | 游标,0 开始 | number | 是 |
length | 分页量,默认 10 | number | 是 |
channel_id | 指定栏目,多个使用使用英文逗号拼接 | string | 否 |
search_keywords | 关键字搜索 | string | 否 |
show_access | 是否显示权限 0 不校验 1 展示是否有权限 2 只展示有权限数据 | number | 否 |
CmsArListResp 类型
ts
interface CMS_AR_LIST_RESP {
access_limit: string; // string
access_type: number;
app_id: number;
arc_from: string;
attach: string; // JSON 格式的字符串
attach_ext: string; // string
audit_id: number;
audit_state: number;
author: string;
back_img: string;
channel_id: number;
company_id: number;
content: string; // URL 编码的 HTML 内容
content_clear: number;
content_mobile: string; // string
cover: string;
created_at: string; // 日期时间字符串
desc: string;
html_name: string; // string
icon: string;
id: number;
operator_id: number;
real_channel: string;
real_template_channel: number;
real_template_channel_diy: {
id: number;
alias: string;
template_name: string;
}; // 嵌套对象
real_template_content: number;
real_template_content_diy: any[]; // 未指定类型的数组,因此使用 any[]
real_template_text: number;
real_template_text_diy: {
id: number;
alias: string;
template_name: string;
}; // 嵌套对象
real_template_type: number;
release_time: string; // 日期时间字符串
seo_description: string; // string
seo_keywords: string; // string
seo_name: string; // string
show_access: number;
sort: number;
state: number;
tag: string; // string
tag_name: string;
template_text: number;
template_text_diy: any[]; // 未指定类型的数组,因此使用 any[]
title: string;
title_sub: string;
type: string;
updated_at: string; // 日期时间字符串
view_num: number;
is_access: number; // 在show_access非0时有效,1为有权限0为无权限
}
参数名 | 参数描述 | 类型 | 默认参照值 |
---|---|---|---|
title | 标题 | string | "林更新新活动亮相" |
title_sub | 副标题 | string | "" |
is_access | 展示权限 | number | 在 show_access 非 0 时有效,1 为有权限 0 为无权限 |
type | 类型 | string | "1" |
attach | 附件链接 | array | ["https://...", "https://..."] |
attach_ext | 附件扩展 | string | "" |
access_limit | 访问限制 | string | "" |
access_type | 访问类型 | number | 0 |
content | 内容 | string | "%3Cp%20style%3D%22..." |
icon | 图标 | string | "https://..." |
cover | 封面图片 | string | "https://..." |
id | ID | number | 24 |
content_clear | 清晰内容 | number | 0 |
content_mobile | 移动端内容 | string | "" |
arc_from | 文章来源 | string | "" |
audit_id | 审核 ID | number | 0 |
audit_state | 审核状态 | number | 1 |
author | 作者 | string | "" |
back_img | 背景图片 | string | "" |
channel_id | 频道 ID | number | 16 |
app_id | 应用 ID | number | 270 |
company_id | 公司 ID | number | 102 |
html_name | HTML 名称 | string | "" |
created_at | 创建时间 | string | "2024-04-23 10:05:08" |
desc | 描述 | string | "" |
operator_id | 操作员 ID | number | 284 |
real_channel | 真实频道 | string | "图集" |
real_template_channel | 真实模板频道 | number | 118 |
real_template_channel_diy | 自定义模板频道 | object | |
real_template_content | 真实模板内容 | number | 0 |
real_template_content_diy | 自定义模板内容 | array | [] |
real_template_text | 真实模板文字 | number | 110 |
real_template_text_diy | 自定义模板文字 | object | |
real_template_type | 真实模板类型 | number | 3 |
release_time | 发布时间 | string | "2024-04-26 11:35:19" |
seo_description | SEO 描述 | string | "" |
seo_keywords | SEO 关键词 | string | "" |
seo_name | SEO 名称 | string | "" |
show_access | 显示访问权限 | number | 0 |
sort | 排序 | number | 50 |
state | 状态 | number | 1 |
tag | 标签 | string | "" |
tag_name | 标签名称 | string | "新闻,热点,股票,股票 2,股票 1" |
template_text | 模板文字 | number | 0 |
template_text_diy | 自定义模板文字 | array | [] |
updated_at | 更新时间 | string | "2024-04-26 15:08:05" |
view_num | 浏览次数 | number | 19 |
文章详情
CmsArDetailParams 类型
ts
interface CMS_AR_DETAIL_PARAMS {
id: number; // id
show_access: number; // 是否显示权限 0不校验 1展示是否有权限 2只展示有权限数据
}
参数名 | 参数描述 | 类型 | 是否必填 |
---|---|---|---|
id | id | number | 是 |
show_access | 是否显示权限 0 不校验 1 展示是否有权限 2 只展示有权限数据 | number | 否 |
CmsArDetailResp 类型
ts
interface CMS_AR_DETAIL_RESP {
alias: "pQwFBx7Cx9T6l6TIP";
app_id: number;
app_type: number;
company_id: number;
created_at: string;
deleted_at: string;
diy_app_id: number;
id: number;
ip: string;
is_default: number;
is_wechat: number;
json: string;
operator_id: number;
order: number;
router_id: number;
router_name: string;
router_url: string;
state: number;
template_id: number;
title: string;
updated_at: string;
is_access: number; // 在show_access非0时有效,1为有权限0为无权限
}
属性名 | 说明 | 数据类型 | 示例值 |
---|---|---|---|
title | 标题 | string | "(勿动!)索尔维在中国市场应用" |
json | JSON 数据 | string | "" |
template_id | 模板 ID | number | 0 |
alias | 别名 | string | "pQwFBx7Cx9T6l6TIP" |
is_access | 展示权限 | number | 在 show_access 非 0 时有效,1 为有权限 0 为无权限 |
app_id | 应用 ID | number | 261 |
id | ID | number | 792 |
order | 排序 | number | 50 |
router_id | 路由 ID | number | 1 |
router_name | 路由名称 | string | "DIY 公共页" |
router_url | 路由 URL | string | "/common/index/index" |
state | 状态 | number | 1 |
app_type | 应用类型 | number | 0 |
company_id | 公司 ID | number | 102 |
created_at | 创建时间 | string | "2024-05-30 13:35:59" |
deleted_at | 删除时间(null 表示未删除) | string | "" |
diy_app_id | DIY 应用 ID | number | 0 |
ip | IP 地址 | string | "" |
is_default | 默认设置标志 | number | 0 |
is_wechat | 微信标志 | number | 1 |
operator_id | 操作员 ID | number | 262 |
updated_at | 更新时间 | string | "2024-06-05 09:55:59" |
栏目列表
CmsChListParams 类型
ts
interface CMS_CH_LIST_PARAMS {
parent_id: number; // 上级类别id
show_access: number; // 是否显示权限 0不校验 1展示是否有权限 2只展示有权限数据
}
参数名 | 参数描述 | 类型 | 是否必填 |
---|---|---|---|
parent_id | 上级类别 id | number | 是 |
show_access | 是否显示权限 0 不校验 1 展示是否有权限 2 只展示有权限数据 | number | 否 |
CmsChListResp 类型
ts
interface CMS_CH_LIST_RESP {
app_id: number; // 示例值: 270
article_count: number; // 示例值: 1
back_img: string; // 示例值: ""
company_id: number; // 示例值: 102
content: string; // 示例值: ""
content_mobile: string; // 示例值: ""
cover: string; // 示例值: ""
created_at: string; // 示例值: "2024-04-23 09:58:16"
desc: string; // 示例值: ""
directory: string; // 示例值: ""
icon: string; // 示例值: ""
id: number; // 示例值: 14
is_parent: number; // 示例值: 0
name: string; // 示例值: "单页"
name_alias: string; // 示例值: ""
operator_id: number; // 示例值: 284
parent_id: number; // 示例值: 0
real_parent: string; // 示例值: string
real_top: string; // 示例值: string
seo_description: string; // 示例值: ""
seo_keywords: string; // 示例值: ""
seo_name: string; // 示例值: ""
show_access: number; // 示例值: 0
show_hide: number; // 示例值: 0
sort: number; // 示例值: 50
state: number; // 示例值: 1
sub_title: string; // 示例值: ""
sync_sub: number; // 示例值: 0
template_channel: number; // 示例值: 6
template_channel_diy: any[]; // 示例值: []
template_content: number; // 示例值: 0
template_content_diy: any[]; // 示例值: []
template_text: number; // 示例值: 0
template_text_diy: any[]; // 示例值: []
template_type: number; // 示例值: 1
title: string; // 示例值: "单页"
top_id: number; // 示例值: 0
type: number; // 示例值: 1
type_show: number; // 示例值: 2
updated_at: string; // 示例值: "2024-05-14 09:28:36"
url_link: string; // 示例值: ""
url_type: number; // 示例值: 0
view_num: number; // 示例值: 65
is_access: number; // 在show_access非0时有效,1为有权限0为无权限
}
属性名 | 说明 | 数据类型 | 示例值 |
---|---|---|---|
title | 标题 | string | "单页" |
is_access | 展示权限 | number | 在 show_access 非 0 时有效,1 为有权限 0 为无权限 |
top_id | 顶级 ID | number | 0 |
app_id | 应用 ID | number | 270 |
article_count | 文章数量 | number | 1 |
back_img | 背景图片 | string | "" |
company_id | 公司 ID | number | 102 |
content | 内容 | string | "" |
content_mobile | 移动端内容 | string | "" |
cover | 封面图片 URL | string | "" |
url_link | 链接 URL | string | "" |
url_type | 链接类型 | number | 0 |
view_num | 查看次数 | number | 65 |
sort | 排序 | number | 50 |
state | 状态 | number | 1 |
sub_title | 副标题 | string | "" |
sync_sub | 同步子级 | number | 0 |
template_channel | 模板频道 | number | 6 |
template_channel_diy | 自定义模板频道 | array | [] |
template_content | 模板内容 | number | 0 |
template_content_diy | 自定义模板内容 | array | [] |
template_text | 模板文本 | number | 0 |
template_text_diy | 自定义模板文本 | array | [] |
template_type | 模板类型 | number | 1 |
created_at | 创建时间 | string | "2024-04-23 09:58:16" |
desc | 描述 | string | "" |
directory | 目录 | string | "" |
icon | 图标 URL | string | "" |
id | ID | number | 14 |
is_parent | 是否为父级 | number | 0 |
name | 名称 | string | "单页" |
name_alias | 名称别名 | string | "" |
operator_id | 操作员 ID | number | 284 |
parent_id | 父级 ID | number | 0 |
real_parent | 实际父级 | string | "" |
real_top | 实际顶级 | string | "" |
seo_description | SEO 描述 | string | "" |
seo_keywords | SEO 关键词 | string | "" |
seo_name | SEO 名称 | string | "" |
show_access | 显示访问权限 | number | 0 |
show_hide | 显示隐藏状态 | number | 0 |
type | 类型 | number | 1 |
type_show | 显示类型 | number | 2 |
updated_at | 更新时间 | string | "2024-05-14 09:28:36" |
栏目详情
CmsChDetailParams 类型
ts
interface CMS_CH_DETAIL_PARAMS {
id: number; // id
show_access: number; // 是否显示权限 0不校验 1展示是否有权限 2只展示有权限数据
}
参数名 | 参数描述 | 类型 | 是否必填 |
---|---|---|---|
id | id | number | 是 |
show_access | 是否显示权限 0 不校验 1 展示是否有权限 2 只展示有权限数据 | number | 否 |
CmsChDetailResp 类型
ts
interface CMS_CH_DETAIL_RESP {
id: number; // 示例值: 123
name: string; // 示例值: "栏目名称"
sort: number; // 示例值: 1
state: number; // 示例值: 1 (开启), 0 (关闭)
operator_id: number; // 示例值: 456
created_at: string; // 示例值: "2024-06-20 10:00:00"
updated_at: string; // 示例值: "2024-06-20 10:30:00"
top_id: number; // 示例值: 0
parent_id: number; // 示例值: 0
is_parent: number; // 示例值: 0 (否), 1 (是)
name_alias: string; // 示例值: "english_alias"
directory: string; // 示例值: "directory_name"
template_content: number; // 示例值: 1
template_channel: number; // 示例值: 2
template_text: number; // 示例值: 3
show_hide: number; // 示例值: 0
show_access: number; // 示例值: 0 (开放浏览), 1 (禁止浏览)
type: number; // 示例值: 1 (内部栏目), 2 (外部链接)
url_link: string; // 示例值: "http://example.com"
url_type: number; // 示例值: 0, 1, 2
cover: string; // 示例值: "cover_image_url"
seo_name: string; // 示例值: "SEO标题"
seo_keywords: string; // 示例值: "SEO关键词"
seo_description: string; // 示例值: "SEO描述"
article_count: number | string; // 示例值: 10 或 string
sync_sub: number; // 示例值: 0
view_num: number; // 示例值: 100
type_show: number; // 示例值: 1, 2, 3
is_access: number; // 在show_access非0时有效,1为有权限0为无权限
}
属性名 | 说明 | 数据类型 | 示例值 |
---|---|---|---|
id | ID | number | 123 |
name | 栏目名称 | string | "栏目名称" |
is_access | 展示权限 | number | 在 show_access 非 0 时有效,1 为有权限 0 为无权限 |
type_show | 栏目类型 1 文本 2 列表 3 单页 | number | 1 |
sort | 排序 | number | 1 |
state | 状态 (1: 开启, 0: 关闭) | number | 1 |
top_id | 顶级 ID | number | 0 |
parent_id | 父级 ID | number | 0 |
is_parent | 是否为父级 (0: 否, 1: 是) | number | 0 |
directory | 目录名称 | string | "directory_name" |
template_content | 内容模板 | number | 1 |
template_channel | 频道模板 | number | 2 |
template_text | 文本模板 | number | 3 |
show_hide | 显示隐藏状态 | number | 0 |
show_access | 访问权限 0 开放浏览 1 禁止浏览 | number | 0 |
type | 类型 (1: 内部栏目, 2: 外部链接) | number | 1 |
url_link | 链接地址 | string | "http://example.com" |
url_type | 链接属性 0 无 1 新窗口打卡 2nofollow | number | 0 |
cover | 封面图片 URL | string | "cover_image_url" |
seo_name | SEO 标题 | string | "SEO 标题" |
seo_keywords | SEO 关键词 | string | "SEO 关键词" |
seo_description | SEO 描述 | string | "SEO 描述" |
article_count | 文章数量 | number | 1 |
sync_sub | 子栏目同步 | number | 0 |
view_num | 浏览次数 | number | 100 |
operator_id | 操作员 ID | number | 456 |
created_at | 创建时间 | string | "2024-06-20 10:00:00" |
updated_at | 更新时间 | string | "2024-06-20 10:30:00" |
name_alias | 英文别名 | string | "english_alias" |