获取AnQiCMS文档列表时,如何确保只返回父级分类下的文档,而不包含子分类?

📅 👁️ 80

在使用安企CMS管理网站内容时,我们经常会遇到需要精确控制文档显示范围的情况。例如,当您希望在某个父级分类页面上,只展示该分类直接发布的文档,而不涉及其下属子分类中的内容时,就需要对文档列表的获取方式进行一番调整。安企CMS提供了非常灵活的API接口,让您轻松实现这一需求。

要确保获取到的文档列表只包含父级分类下的内容,而自动排除所有子分类的文档,核心在于巧妙利用archiveList接口中的categoryIdchild这两个参数。

首先,您会使用到安企CMS的获取文档列表接口,其API调用地址是 {域名地址}/api/archive/list。这是一个强大的接口,允许您根据多种条件筛选和排序文档。

当您指定了一个categoryId时,默认情况下,安企CMS会很“聪明”地将该分类及其所有子分类下的文档都一并返回。这在构建聚合页面时非常方便。然而,如果您的设计意图是只展示当前分类的直接内容,这种默认行为可能就不太合适了。

此时,child参数就派上了用场。child参数是一个布尔值(boolean),它决定了是否包含所有子分类的文档。它的默认值是 true,意味着会包含子分类。而当您需要限定范围,只显示当前指定categoryId的文档时,只需将child参数设置为 false

举个例子,假设您的网站有一个名为“新闻中心”的父级分类,其categoryId100。在“新闻中心”下,可能还有“国内新闻”、“国际新闻”等子分类。如果您想在“新闻中心”的列表中,仅显示直接归属到“新闻中心”这个分类的文档,而不包括“国内新闻”或“国际新闻”中的文章,您就可以这样构造您的API请求:

GET {域名地址}/api/archive/list?categoryId=100&child=false

通过这样的请求,安企CMS会准确地为您筛选出那些category_id正好是 100的文档,而所有parent_id100(即“新闻中心”的子分类)的文档则会被巧妙地排除在外。

这种精细化的控制能力,对于内容运营来说意义重大。它让您可以根据页面的具体功能和用户浏览习惯,呈现最贴切、最相关的内容。比如,在一个分类的介绍页,您可能只想展示该分类本身的概览性文章;而在一个综合列表页,您又可以利用默认的child=true(或省略child参数)来全面呈现所有相关内容。这种灵活性确保了网站内容架构的清晰度和用户体验的优化。

常见问题解答 (FAQ)

Q1: 如果我想显示指定分类及其所有子分类的文档,应该怎么操作? A1: 如果您想获取指定分类下的所有文档,包括其子分类中的文档,那么您可以省略child参数,或者明确将其设置为 child=true,因为 truechild参数的默认行为。例如:GET {域名地址}/api/archive/list?categoryId=100 就能达到这个效果。

Q2: 我能否同时获取多个父级分类下的文档,并且同样不包含这些父级分类的子分类? A2: 可以的。categoryId参数支持传入用逗号隔开的多个分类ID。所以,您可以这样构造请求:GET {域名地址}/api/archive/list?categoryId=100,101,102&child=false。这将返回categoryId100101102的直接文档,而不会包含这些分类的任何子分类中的文档。

Q3: 这个child=false参数是否也适用于按模型ID(moduleId)获取文档列表? A3: 是的,child=false参数主要与categoryId结合使用,用来控制特定分类层级的文档包含关系。moduleId用于筛选特定文档模型(如文章、产品等)下的所有文档。您可以先通过moduleId指定文档模型,再通过categoryIdchild=false进一步细化过滤结果。例如:GET {域名地址}/api/archive/list?moduleId=1&categoryId=100&child=false 将获取文章模型下、且直接属于分类ID为100的文档。

相关文章

`url_token`在AnQiCMS文档列表结果中有什么作用,如何用于生成友好的URL?

在AnQiCMS中,`url_token` 是一个至关重要的概念,它不仅仅是文档列表中的一个字段,更是构建网站友好URL(Friendly URL)的核心要素。理解它的作用和使用方式,能帮助我们更好地优化网站结构,提升用户体验和搜索引擎排名。 ### `url_token` 在文档列表结果中的作用 当我们通过AnQiCMS的API获取文档列表时,例如调用 `archive/list` 接口

2025-11-09

如何高效地从AnQiCMS文档列表中提取并显示文章简介(`description`字段)?

在内容管理中,为网站上的文章提供清晰、吸引人的简介至关重要。这不仅能帮助搜索引擎更好地理解页面内容,提高收录和排名,也能在列表页、搜索结果页或社交分享时,快速抓住访问者的注意力,引导他们点击阅读完整内容。安企CMS(AnQiCMS)提供了多种灵活的方式来管理和获取这些内容,其中高效地提取并显示文章简介 (`description` 字段`) 便是我们日常运营中一个常见的需求。 AnQiCMS

2025-11-09

当`archive/list`返回`code`为`-1`时,`msg`字段会给出哪些错误信息?

在使用安企CMS进行网站内容管理时,我们经常会与各项API接口打交道,其中 `archive/list` 接口是获取文档列表的核心。在使用过程中,您可能会遇到接口返回 `code` 为 `-1` 的情况。此时,理解 `msg` 字段提供的信息就显得尤为重要,它能帮助我们快速定位问题所在。 当 `archive/list` 接口返回 `code: -1` 时,这意味着请求未能成功执行

2025-11-09

如何结合`archiveFilters.md`获取的筛选条件,应用到`archive/list`的自定义筛选参数中?

在安企CMS中,高效地管理和展示网站内容是提升用户体验的关键。当内容量日益增长时,提供灵活的筛选功能,帮助访客快速找到所需信息,显得尤为重要。安企CMS为此提供了强大的API接口支持,通过巧妙地结合`archive/filters`接口获取的筛选条件,并将其应用到`archive/list`接口的自定义筛选参数中,我们可以构建出极其实用的内容筛选功能。 ###

2025-11-09

我想在AnQiCMS文档列表页面显示每篇文章的评论数量,应该查看哪个字段?

在AnQiCMS的日常使用中,许多运营者都希望能够直观地在文章列表页面展示每篇文章的评论数量。这不仅能有效提升内容的活跃度,更能帮助用户快速了解哪些文章更受欢迎、更具讨论价值。那么,在众多的数据字段中,我们究竟应该关注哪一个,才能实现这个需求呢? 要实现在AnQiCMS文档列表页面显示每篇文章的评论数量,您需要查找的核心数据字段是 **`comment_count`**

2025-11-09

`archive/list`接口返回的`price`和`stock`字段,对电商类文档模型有何意义?

在安企CMS中,当您通过`archive/list`接口获取文档列表时,返回数据中包含的`price`和`stock`这两个字段,对于构建电商类型的网站模型来说,具有至关重要的意义。它们不仅仅是简单的数值,而是支撑商品展示、交易流程和库存管理的核心要素。 ### 奠定商品基础:价格与库存的直观表达 首先

2025-11-09

如何通过AnQiCMS文档列表获取指定用户(`user_id`)发布的文章?

在网站内容运营中,我们常常需要展示特定作者的所有文章,例如在作者个人主页上,或者在某个专题页面中聚合特定贡献者的内容。安企CMS(AnQiCMS)提供了强大而灵活的API接口,让我们能够轻松地实现这一需求。 要获取指定用户(`user_id`)发布的所有文章列表,我们需要借助 `archive/list` 接口。这个接口是安企CMS用于检索文档列表的核心功能

2025-11-09

`archive/list`接口在不传递任何参数时,默认的行为和返回内容是什么?

## 深入解析安企CMS `archive/list` 接口:不带参数时的默认行为与返回内容 在使用安企CMS(AnQiCMS)进行网站开发或内容管理时,我们经常需要通过API接口获取各种数据。`archive/list` 接口是获取网站文档列表的核心接口之一。理解它在不传递任何参数时的默认行为和返回内容,对于高效地进行数据获取和初步调试至关重要。 ### 接口地址与调用方式概览 首先

2025-11-09