Skip to main content

REST API:status

REST API 提供了根据结果状态（草稿或已发布）过滤结果的功能。

¥The REST API offers the ability to filter results based on their status, draft or published.

Prerequisites

应启用 起草并发布 功能。

¥The Draft & Publish feature should be enabled.

查询可以接受 status 参数来明确定义要填充哪些字段，语法选项示例如下。

¥Queries can accept a status parameter to fetch documents based on their status:

  • published：仅返回文档的已发布版本（默认）

    ¥published: returns only the published version of documents (default)

  • draft：仅返回文档的草稿版本

    ¥draft: returns only the draft version of documents

提示

在响应数据中，publishedAt 字段对于草稿为 null。

¥In the response data, the publishedAt field is null for drafts.

注意

由于默认返回已发布的版本，因此不传递状态参数相当于传递 status=published。

¥Since published versions are returned by default, passing no status parameter is equivalent to passing status=published.



Get draft versions of restaurants

GET /api/articles?status=draft

JavaScript query (built with the qs library):

上面的查询 URL 是使用 `qs` 库  构建的。qs 可以在你的计算机上本地运行，如以下代码示例所示，或者你也可以使用我们的 交互式查询构建器 在线工具。

¥The query URL above was built using the `qs` library . qs can be run locally on your machine, as shown in the following code example, or you can use our interactive query builder online tool.

const qs = require('qs');
const query = qs.stringify({
  status: 'draft',
}, {
  encodeValuesOnly: true, // prettify URL
});

await request(`/api/articles?${query}`);
Example response

!!!IG0!!!