如何筛选AnQiCMS文档列表,仅显示特定分类(`categoryId`)下的文章?

📅 👁️ 78

在安企CMS中管理和展示大量内容时,如何精准地筛选出特定分类下的文章,是提升网站内容组织性和用户体验的关键一环。安企CMS提供了强大且灵活的接口,让我们可以轻松实现这一目标。本文将详细介绍如何通过安企CMS的文档列表接口,仅显示您希望的特定分类文章。

掌握文档列表接口:内容筛选的核心

要筛选特定分类下的文章,我们需要利用安企CMS提供的 /api/archive/list 接口。这个接口是获取网站文档列表的核心,它允许您通过多种参数来精确控制返回的文章集合。

该接口的调用方法是 GET,这意味着您可以通过URL参数来传递筛选条件。其中,categoryId 参数就是我们实现按分类筛选文章的关键。

理解 categoryId 参数

categoryId 参数允许您指定一个或多个分类的ID,接口会返回属于这些分类的文章。

  • 单一分类筛选:如果您只想显示某个具体分类下的文章,可以直接传递该分类的ID。例如,如果您想获取ID为 10 的分类下的文章,请求参数中就可以包含 categoryId=10
  • 多分类筛选:如果您希望同时显示多个分类下的文章,categoryId 参数也支持以逗号 , 分隔的形式传递多个分类ID。例如,要获取ID为 101215 的分类下的文章,您可以设置 categoryId=10,12,15

构建您的筛选请求

除了 categoryId,在实际应用中,通常还需要配合其他参数来构建完整的请求,以确保获取到您真正需要的内容。

  • moduleId(模型ID):文档通常会归属于特定的模型(如文章模型、产品模型等)。为了更精确地筛选,建议您也指定 moduleId。例如,moduleId=1 表示获取文章模型下的文档。
  • type(列表类型):当您需要获取分页列表并显示总数时,通常会将 type 设置为 page。如果只是想简单列出指定数量的文档,type 可以省略或设置为 list
  • child(子分类包含):一个分类可能包含多个子分类。如果您希望不仅显示当前分类的文章,还包括其所有子分类的文章,可以将 child 参数设置为 true。默认情况下,安企CMS通常会包含子分类,但明确指定 child=false 可以只获取当前分类直属的文章,而不包含其子分类的内容。
  • limitpage(分页控制):为了控制每页显示的文章数量和获取特定页码的内容,可以分别使用 limitpage 参数。例如,limit=10&page=1 表示获取第一页的10篇文章。

一个完整的请求示例可能看起来像这样:

{域名地址}/api/archive/list?moduleId=1&categoryId=10,12,15&type=page&limit=10&page=1&child=true

这条请求的含义是:获取文章模型(moduleId=1)下,分类ID为 101215(包含子分类)的文章,以分页形式展示,每页10条,获取第一页的内容。

解析返回结果

当您发送请求后,安企CMS会返回一个JSON格式的响应。成功的响应通常会包含 code: 0 和一个 data 字段,其中 data 字段就是一个包含符合筛选条件文章的数组。每篇文章对象中都会包含 idtitledescriptioncategory_id 等详细信息,您可以根据这些信息在前端进行展示。

通过检查返回数据的 category_id 字段,您可以验证接口是否按照您的预期进行了筛选。此外,如果 type 参数设置为 page,响应中还会包含一个 total 字段,告诉您符合条件的文档总数,这对于实现分页功能非常有帮助。

小结

通过灵活运用 archive/list 接口及其 categoryId 参数,您可以精准地控制安企CMS网站上内容的展示。无论是构建分类列表、特定专题页面,还是实现更复杂的筛选功能,这个接口都能提供坚实的支持。结合 moduleIdtypechild 等参数,您可以创建出功能丰富且用户友好的内容展示页面。


常见问题 (FAQ)

1. 如何获取分类的 categoryId

您可以通过调用 /api/category/list 接口来获取所有分类的列表,其中每个分类都会包含 id 字段,这就是您需要的 categoryId。您也可以通过 /api/category/detail 接口,传入分类名称(catnamefilename)来获取单个分类的详细信息,其中也包含了 id

2. 我想显示某个分类下的文章,但是不包括子分类的文章,应该怎么做?

在调用 /api/archive/list 接口时,将 child 参数设置为 false 即可。例如:categoryId=10&child=false。这样,接口将只返回直接属于ID为 10 的分类的文章,而不会包含其下属子分类的文章。

3. 如果我需要排除某些分类的文章,而不是只显示特定分类的文章,该如何操作?

安企CMS的 /api/archive/list 接口还提供了一个 excludeCategoryId 参数。您可以将需要排除的分类ID以逗号 , 分隔的形式传递给这个参数。例如,excludeCategoryId=10,12 将会返回所有文章,但排除掉属于ID为 1012 分类的文章。

相关文章

AnQiCMS文档列表如何实现按发布时间、浏览量或更新时间降序排列?

在网站运营中,如何高效地呈现内容列表,使用户能够快速找到他们最感兴趣或最有价值的信息,是一个重要的课题。安企CMS(AnQiCMS)提供了灵活的文档列表功能,让我们可以轻松实现内容列表按多种条件降序排列,例如按发布时间、浏览量或更新时间。这不仅能优化用户体验,也有助于提升内容的曝光度和互动性。 ### 安企CMS文档列表排序的核心:`archive/list`

2025-11-09

如何精确控制AnQiCMS文档列表的返回数量和起始偏移量(`limit`参数进阶用法)?

在构建和管理网站内容时,AnQiCMS 提供了一系列灵活的API接口,帮助我们精确地获取和展示数据。其中,`archive/list` 接口是获取文档列表的核心,而它的`limit` 参数,在控制返回数量和起始偏移量方面,展现了其强大的精细控制能力。了解并善用`limit`参数的进阶用法,能够让我们的网站内容展示更加灵活高效。 ### `limit` 参数的基础用法

2025-11-09

在AnQiCMS文档列表接口中,`type="page"`和`type="list"`模式的主要区别是什么?

当您在使用AnQiCMS构建网站并需要从后端获取文档内容时,会经常接触到文档列表接口(`/api/archive/list`)。这个接口提供了一个非常重要的 `type` 参数,它决定了您将以何种方式获取和处理文档列表数据。深入理解 `type="page"` 和 `type="list"` 这两种模式的核心区别,对于提升网站性能、优化用户体验以及更灵活地开发功能都至关重要。 ###

2025-11-09

如何通过AnQiCMS获取指定模型(`moduleId`)的最新文档列表?

在网站内容管理中,我们常常需要动态地展示某一类内容的最新更新,例如新闻文章、产品发布或是博客动态。对于使用 AnQiCMS 搭建的网站而言,借助其提供的强大 API 接口,获取指定模型下的最新文档列表是一项非常基础且实用的操作。这不仅能帮助开发者快速构建动态页面,也能为用户提供及时更新的信息,优化网站的用户体验。 要实现这一功能,我们主要会用到 AnQiCMS 提供的

2025-11-09

AnQiCMS文档列表接口是否支持同时排除多个分类的文档(`excludeCategoryId`用法)?

在网站运营中,我们经常需要灵活地展示内容,例如在一个页面上展示最新文章,但又不希望包含某些特定分类下的内容,比如公告或内部新闻。AnQiCMS 作为一款功能强大的内容管理系统,提供了丰富的API接口来满足这些复杂的显示需求。今天,我们就来深入探讨 `archive/list` 接口中的一个非常实用的参数:`excludeCategoryId`,特别是它如何支持同时排除多个分类的文档。 ###

2025-11-09

如何在AnQiCMS中获取具有“头条”或“幻灯”推荐属性(`flag`)的文档列表?

在安企CMS(AnQiCMS)中,内容运营者常常需要灵活地展示网站上的重要内容,例如将特定文章设置为“头条”或“幻灯”来吸引用户的注意力。安企CMS为此提供了一个非常实用的功能,那就是通过“推荐属性”(`flag`)来标记文档。如果您想获取这些被特殊标记的文档列表,AnQiCMS的API接口能够帮助您轻松实现。 ### 理解文档的“推荐属性”(`flag`) 在安企CMS中

2025-11-09

当获取文档列表时,`child=false`参数如何影响分类及其子分类的显示?

在安企CMS中,`archive/list` 接口是获取网站文档列表的核心工具,它提供了丰富多样的参数,帮助我们精准地筛选和展示内容。其中,`child` 参数虽然看似简单,却在分类及其子分类的文档显示上扮演着至关重要的角色,直接影响着内容呈现的颗粒度。理解并善用这个参数,能让你的网站内容组织更加清晰、用户体验更佳。 默认情况下,当你通过 `archive/list`

2025-11-09

如何利用`q`参数在AnQiCMS文档列表中进行关键词搜索,实现站内搜索功能?

在日常的网站运营中,为用户提供高效便捷的站内搜索功能,是提升用户体验、引导内容发现的关键一环。对于使用安企CMS(AnQiCMS)来管理网站内容的我们而言,实现这一功能并非难事。安企CMS提供了一个非常实用的参数——`q`,让我们能够轻松地在文档列表中进行关键词搜索。 ### 开启站内搜索之旅:理解 `q` 参数 在安企CMS的文档列表接口(`/api/archive/list`)中,`q`

2025-11-09