获取文档列表接口

获取系统中指定条件的文档列表，支持多种筛选和排序方式，可以获取指定模型、分类、推荐属性等条件下的文档列表。此接口同时适用于文档和产品类型的内容。

注意事项

• 接口支持多种类型的数据获取（page、list、related），不同类型的参数效果可能不同
• 当 type=“page” 时，支持分页功能和搜索功能
• 支持自定义筛选参数，可根据模型中配置的字段进行筛选
• 部分字段如价格、库存等仅在产品类型文档中有效
• total 字段仅在 type=page 时返回

请求地址

{域名地址}/api/archive/list

说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/archive/list

请求语法

GET {域名地址}/api/archive/list?{参数}

请求头

此接口仅涉及公共请求头。更多信息，请参见公共请求头（Common Request Headers）。

请求参数

响应头

此接口仅涉及公共相应头。更多信息，请参见公共请求头（Common Request Headers）。

返回参数

data结果item参数

extra文档其他字段信息

extra 根据模型设置的字段显示，字段结构为 key => item： key 表单字段调用名，item 为内容：

请求数据示例

使用示例

请求示例

GET /api/archive/list?moduleId=1&type=page HTTP/1.1
Host: your-domain.com
Content-Type: application/json

响应示例

{
  "code": 0,
  "data": [
    {
      "id": 1,
      "created_time": 1607308159,
      "updated_time": 1662717106,
      "title": "关于AnqiCMS",
      "seo_title": "",
      "url_token": "design",
      "keywords": "",
      "description": "安企内容管理系统(AnqiCMS)，是一款使用 GoLang 开发的企业站内容管理系统，它部署简单，软件安全，界面优雅，小巧，执行速度飞快，使用 AnqiCMS 搭建的网站可以防止众多安全问题发生。",
      "module_id": 1,
      "category_id": 1,
      "views": 1338,
      "comment_count": 0,
      "images": null,
      "template": "",
      "status": 1,
      "canonical_url": "",
      "fixed_link": "",
      "flag": "",
      "user_id": 0,
      "price": 0,
      "stock": 9999999,
      "has_pseudo": 0,
      "keyword_id": 0,
      "origin_url": "",
      "origin_title": "",
      "category": null,
      "module_name": "",
      "data": null,
      "logo": "https://www.anqicms.com/uploads/202012/7/bd36c37ef742c7be.webp",
      "thumb": "https://www.anqicms.com/uploads/202012/7/thumb_bd36c37ef742c7be.webp",
      "extra": {
        "author": {
          "name": "作者",
          "value": "AnqiCMS",
          "default": null
        },
        "certificate": {
          "name": "学历",
          "value": null,
          "default": null
        },
        "city": {
          "name": "城市",
          "value": null,
          "default": null
        }
      },
      "link": "https://www.anqicms.com/design"
    },
    {
      "id": 2,
      "created_time": 1607308247,
      "updated_time": 1611373941,
      "title": "AnqiCMS使用帮助",
      "seo_title": "",
      "url_token": "help",
      "keywords": "",
      "description": "anqicms常见问题汇总",
      "module_id": 1,
      "category_id": 1,
      "views": 1655,
      "comment_count": 0,
      "images": null,
      "template": "",
      "status": 1,
      "canonical_url": "",
      "fixed_link": "",
      "flag": "",
      "user_id": 0,
      "price": 0,
      "stock": 9999999,
      "has_pseudo": 0,
      "keyword_id": 0,
      "origin_url": "",
      "origin_title": "",
      "category": null,
      "module_name": "",
      "data": null,
      "logo": "https://www.anqicms.com/uploads/202012/7/bd36c37ef742c7be.webp",
      "thumb": "https://www.anqicms.com/uploads/202012/7/thumb_bd36c37ef742c7be.webp",
      "extra": null,
      "link": "https://www.anqicms.com/help"
    }
  ],
  "msg": "",
  "total": 2
}

错误代码