生成页面 API

生成页面，使用 POST 发起请求，请求地址为 /api/v1/create。

POST /api/v1/create

请求 URI

参数名	位置	类型	必填	说明
apiKey	query	字符串	否	API 密钥，请参考身份认证

请求 Body

参数名	类型	必填	说明
siteId	数字	是	站点 Id
type	字符串	是	生成页面类型
channelIds	数字数组	否	栏目 Id 数组
channelContentIds	对象数组	否	栏目/内容 Id 数组
name	字符串	否	模板名称/专题名称

生成首页

将生成页面类型 type 参数设置为 Index，系统将生成网站首页：

POST /api/v1/create
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "siteId": 1,
  "type": "Index"
}

生成栏目页

将生成页面类型 type 参数设置为 Channel，同时传递栏目 Id 数组 channelIds 参数，系统将生成指定 Id 的栏目页面：

POST /api/v1/create
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "siteId": 1,
  "type": "Channel",
  "channelIds": [2,3,4]
}

生成内容页

将生成页面类型 type 参数设置为 Content，同时传递栏目/内容 Id 数组 channelContentIds 参数，系统将生成指定 Id 的内容页面：

POST /api/v1/create
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "siteId": 1,
  "type": "Content",
  "channelContentIds": [
    {
      channelId: 2,
      contentId: 1
    },
    {
      channelId: 2,
      contentId: 2
    }
  ]
}

生成文件页

将生成页面类型 type 参数设置为 File，同时传递模板名称 name 参数，系统将生成指定文件页：

POST /api/v1/create
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "siteId": 1,
  "type": "File",
  "name": "文件模板"
}

生成专题页

将生成页面类型 type 参数设置为 Special，同时传递专题名称 name 参数，系统将生成指定专题页：

POST /api/v1/create
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "siteId": 1,
  "type": "Special",
  "name": "专题名称"
}

生成栏目下所有内容页

将生成页面类型 type 参数设置为 AllContent，同时传递栏目 Id 数组 channelIds 参数，系统将生成指定栏目下的所有内容页面：

POST /api/v1/create
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "siteId": 1,
  "type": "AllContent",
  "channelIds": [2,3,4]
}

生成所有页面

将生成页面类型 type 参数设置为 All，系统将生成网站中包含的所有页面：

POST /api/v1/create
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "siteId": 1,
  "type": "All"
}

返回

名称	类型	说明
200 OK	布尔值	返回表示是否生成成功
401 Unauthorized	Error	认证错误
400 BadRequest	Error	参数错误

示例

请求示例

POST /api/v1/create
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "type": "Index",
  "siteId": 1
}

返回示例

{
  "value": true
}