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

AnQiCMS 提供了一套直观且强大的 API 接口，使得我们可以非常便捷地从后台获取各类数据。对于文章列表及其简介的提取，我们主要会用到 archive/list 这个接口。这个接口设计的初衷就是为了方便开发者和运营人员获取多篇文章的数据，而文章简介字段（description）正包含在其返回的每个文章对象中。

高效利用 archive/list 接口提取简介

要从文档列表中获取文章简介，archive/list 接口是您的首选。它的调用方式简单直接，通过 GET 方法发送请求，并可以在请求中附加一些参数来筛选和控制返回的数据。

首先，您需要知道您的 AnQiCMS 站点的域名地址。API 调用地址的通用格式是：{域名地址}/api/archive/list。例如，如果您的网站域名是 https://www.anqicms.com，那么接口地址就是 https://www.anqicms.com/api/archive/list。

在发起请求时，有几个关键参数值得关注，它们能帮助您精准地获取所需文章列表：

  • moduleId: 这是非常重要的参数，它指定了您要获取的文档模型。比如，常规的文章模型 ID 通常是 1。如果您想获取的是产品列表或其它自定义模型的文章简介，就需要根据实际情况填写相应的 moduleId。
  • categoryId: 如果您希望获取特定分类下的文章简介，可以使用这个参数。您可以传入单个分类 ID，或者用逗号分隔传入多个分类 ID。
  • type: 这个参数控制了列表的返回模式。当您需要进行分页展示时，应将 type 设置为 page。这样，接口会同时返回文章总数（total 字段），便于您构建分页导航。如果仅仅是想获取指定数量的文章，默认的 list 类型就足够了。
  • limit: 用于指定返回的文章数量。例如，limit=10 表示获取 10 篇文章。在需要分页时，它也定义了每页的文章数量。它甚至支持 offset,limit 模式，比如 limit=2,10 表示从第2条数据开始，获取10条数据。
  • page: 仅当 type 设置为 page 时有效，用于指定您要获取的是第几页的内容。

举个例子，如果您想获取文章模型下，ID 为 10 的分类中最新的 5 篇文章的简介，您可以这样构建您的 API 请求：

GET {域名地址}/api/archive/list?moduleId=1&categoryId=10&type=list&limit=5&order=created_time desc

当您发送请求后，如果一切顺利，接口会返回一个 JSON 格式的数据。在这个 JSON 响应中，data 字段是一个数组，数组的每个元素都代表着一篇具体的文章信息。而我们所需要的文章简介，就存储在每个文章对象的 description 字段中。

返回数据示例片段（简化）：

{
  "code": 0,
  "data": [
    {
      "id": 1,
      "title": "关于AnqiCMS",
      "description": "安企内容管理系统(AnqiCMS)，是一款使用 GoLang 开发的企业站内容管理系统，它部署简单，软件安全，界面优雅，小巧，执行速度飞快，使用 AnqiCMS 搭建的网站可以防止众多安全问题发生。",
      // ... 其他文章信息
    },
    {
      "id": 2,
      "title": "AnqiCMS使用帮助",
      "description": "anqicms常见问题汇总",
      // ... 其他文章信息
    }
  ],
  "msg": "",
  "total": 2
}

一旦我们通过 HTTP 请求获取到这些数据，接下来的处理就相对简单了。无论是使用后端语言（如 PHP、Python）将数据渲染到 HTML 模板中，还是在前端框架（如 Vue、React）中解析 JSON 响应，都可以轻松地遍历 data 数组，提取每篇文章的 title 和 description 字段，并在页面上进行展示。

高级应用场景与实践建议

在实际应用中，您可能会遇到一些更复杂的需求，或者需要考虑性能优化。

  1. 特定文章简介的获取： 如果您的场景是已经明确知道某篇文章的 ID 或 URL 别名（url_token），并且只需要获取这一篇文章的详细信息（包括简介），那么 archive/detail 接口会更直接。只需传入文章的 id 或 filename（即 url_token），就能获取到该文章的全部数据，其中也包含 description 字段。但如果您的目的是获取一个列表，那么 archive/list 依然是更高效的选择。

  2. 前端展示的优化： 在前端页面渲染文章列表时，您可以使用这些获取到的简介数据，在文章列表页、搜索结果页或相关文章推荐模块中进行优雅地呈现。例如，将简介限制在一定字数内，或在简介末尾添加“阅读更多”链接，可以保持页面的整洁和用户体验。

  3. 性能优化： 当网站文章数量庞大时，合理利用 limit 和 page 参数进行分页是至关重要的。避免一次性获取所有文章数据，这样可以显著减少服务器压力和数据传输时间，提升网站加载速度。同时，在客户端对已获取的数据进行缓存，也能减少重复请求，进一步优化用户体验。

通过灵活运用 AnQiCMS 提供的 archive/list 接口，我们可以轻松实现对文章简介的高效提取和展示，极大提升网站内容管理的灵活性和用户体验。这不仅让您的网站内容更具吸引力，也为用户提供了更好的导航和信息预览。

常见问题 (FAQ)

1. 如果文章的 description 字段为空或内容过短，我应该如何处理？

当 description 字段缺失或内容不足时，为了确保展示效果，您可以在前端或后端设置一个备用逻辑。一种常见做法是从文章的 content 字段中截取前几十个字作为简介的替代。AnQiCMS 的 archive/list 接口并不会自动为您截取，因此这需要在您接收到数据后，在代码层面进行判断和处理。如果文章内容也不适合直接截取，可以显示一个通用提示，例如“暂无简介”。

2. 获取大量文章列表时，如何避免性能问题？

为了避免性能问题，最关键的是合理利用 archive/list 接口的 limit 和 page 参数。

  • limit 能够限制单次请求返回的文章数量，建议根据页面布局和用户体验设定一个合理的值（例如，每页 10-20 篇文章）。
  • page 配合 type=page 参数使用，可以实现分页加载，只请求当前页所需数据。 此外，您还可以考虑在前端实现懒加载（Infinite Scroll）或无限滚动功能，即当用户滚动到页面底部时再加载下一页内容，进一步提升用户体验。

3. archive/list 接口是否支持获取其他内容类型（如产品、下载）的简介？

是的，archive/list 接口是通用的。只要您在请求中正确指定了 `