开放Api-博客文章-列表
Api描述:获取 博客文章列表
URL: /manager/api/apps/openapi/blog-article/list
格式:json
方式:get
数据请求部分
1.Request Header 参数:
参数名称 | 是否必须 | 类型 | 描述 |
---|---|---|---|
open-access-token | 必须 | String | 在开放api插件中,创建权限后即可获取该token |
2.Request JSON Data(Body):
参数名称 | 是否必须 | 类型 | 描述 |
---|---|---|---|
pageNum | 选填 | String | 每页的个数 |
pageSize | 选填 | String | 第x页 |
title | 选填 | String | 搜索的文章标题 |
is_published | 选填 | String | 文章状态,1代表已发布,2代表未发布 |
注意发布状态:
- 已发布:已发布指的是
发布状态==已发布
&&发布时间<=当前时间
- 未发布:未发布指的是
发布状态==未发布
||发布时间>当前时间
数据返回部分
1.Response JSON Data(Body):
格式:json
参数名称 | 是否必须 | 类型 | 描述 |
---|---|---|---|
code | 必须 | Number | 200 代表成功 |
message | 必须 | String | 执行结果的文字描述信息 |
data | 必须 | Array | api获取的数据保存到data中 |
data > total | 必须 | string | 列表总数 |
data > pageSize | 必须 | string | 列表每页个数 |
data > totalPage | 必须 | string | 列表总页数 |
data > list | 必须 | Array | 专辑列表 |
data > list > id | 必须 | int | id |
data > list > shop_id | 必须 | int | 店铺 id |
data > list > author | 必须 | string | 作者名字 |
data > list > handle | 选填 | string | url handle |
data > list > title | 选填 | string | 标题 |
data > list > summary_html | 选填 | string | 简短描述 |
data > list > body_html | 选填 | string | 内容描述 |
data > list > meta_title | 选填 | string | meta title |
data > list > meta_keywords | 选填 | string | meta keywords |
data > list > meta_description | 选填 | string | meta description |
data > list > image | 选填 | string | 图片 |
data > list > is_published | 选填 | int | 1已发布,2未发布 |
data > list > published_at | 选填 | string | 发布时间 |
data > list > created_at | 必须 | string | 创建时间 |
data > list > updated_at | 必须 | string | 更新时间 |
Response JSON Data(示例数据):
{
"code": 200,
"data": {
"list": [
{
"id": 1,
"shop_id": 15,
"author": "terry3",
"handle": "handle-terr3y",
"title": "title terry3",
"summary_html": "summary_html terry",
"body_html": "body_html terry",
"meta_title": "meta_title terry",
"meta_keywords": "meta_keywords terry",
"meta_description": "meta_description terry",
"image": "/common/15/image/2022/10/16/293e3ac3f4cc6569a1664a98dbdba38a.webp",
"is_published": 1,
"published_at": 1656612124,
"created_at": "2022-06-28 14:51:44",
"updated_at": "2022-06-28 15:39:29"
},
{
"id": 2,
"shop_id": 15,
"author": "terry",
"handle": "handle-terry-57435210",
"title": "title terry",
"summary_html": "summary_html terry",
"body_html": "body_html terry",
"meta_title": "meta_title terry",
"meta_keywords": "meta_keywords terry",
"meta_description": "meta_description terry",
"image": "/common/15/image/2022/10/16/293e3ac3f4cc6569a1664a98dbdba38a.webp",
"is_published": 1,
"published_at": 1656345600,
"created_at": "2022-06-28 14:52:12",
"updated_at": "2022-06-28 14:52:12"
},
{
"id": 3,
"shop_id": 15,
"author": "terry",
"handle": "handle-terry-93921791",
"title": "title terry",
"summary_html": "summary_html terry",
"body_html": "body_html terry",
"meta_title": "meta_title terry",
"meta_keywords": "meta_keywords terry",
"meta_description": "meta_description terry",
"image": "/common/15/image/2022/10/16/293e3ac3f4cc6569a1664a98dbdba38a.webp",
"is_published": 1,
"published_at": 1656345600,
"created_at": "2022-06-28 14:52:15",
"updated_at": "2022-06-28 14:52:15"
},
{
"id": 4,
"shop_id": 15,
"user_id": 1,
"author": "terry",
"handle": "handle-terry-63048641",
"title": "title terry",
"summary_html": "summary_html terry",
"body_html": "body_html terry",
"meta_title": "meta_title terry",
"meta_keywords": "meta_keywords terry",
"meta_description": "meta_description terry",
"meta_is_edit": 1,
"translate_type": 1,
"image": "image terry",
"is_published": 1,
"published_at": 1656399144,
"created_at": "2022-06-28 14:52:24",
"updated_at": "2022-06-28 14:52:24"
},
{
"id": 5,
"shop_id": 15,
"user_id": 1,
"author": "terry",
"handle": "handle-terry-88201647",
"title": "title terry",
"summary_html": "summary_html terry",
"body_html": "body_html terry",
"meta_title": "meta_title terry",
"meta_keywords": "meta_keywords terry",
"meta_description": "meta_description terry",
"meta_is_edit": 1,
"translate_type": 1,
"image": "image terry",
"is_published": 1,
"published_at": 1656399331,
"created_at": "2022-06-28 14:55:31",
"updated_at": "2022-06-28 14:55:31"
},
{
"id": 6,
"shop_id": 15,
"user_id": 1,
"author": "terry",
"handle": "handle-terry-50776765",
"title": "title terry",
"summary_html": "summary_html terry",
"body_html": "body_html terry",
"meta_title": "meta_title terry",
"meta_keywords": "meta_keywords terry",
"meta_description": "meta_description terry",
"meta_is_edit": 1,
"translate_type": 1,
"image": "image terry",
"is_published": 1,
"published_at": 1656399334,
"created_at": "2022-06-28 14:55:34",
"updated_at": "2022-06-28 14:55:34"
}
],
"total": 6,
"pageSize": 20,
"totalPage": 1
},
"message": "success"
}