# hexo-info-api

让 Hexo 把文章、分类和标签输出成 JSON，给其他前端功能使用

Source: https://works.im0o.top/projects/0e405eff/
Date: 2022-09-06
Status: archived
Tags: 开发工具, JavaScript, Hexo, npm

## Project links

- [源代码](https://github.com/jz0ojiang/hexo-info-api)
- [开发记录](https://blog.im0o.top/posts/d3bc8dff.html)


hexo-info-api 是我给 Hexo 写的一个插件，用来把博客里的文章、分类、标签等内容输出成 JSON。博客照常生成静态页面，其他页面或小工具则可以读取这些数据，不用从 HTML 里再找一遍。

## 可以取到哪些数据

内置模块包括站点信息、文章数量、文章列表、分类、标签、最新文章和最近五篇文章。文章还可以按分类、标签、ID 或路径查询。

文章列表返回标题、日期、简介、分类、标签、原链接等信息，单篇文章接口再带上正文。简介优先取 description，没有时取 excerpt，字段整理放在各自的接口模块里。

比如文章数量接口的结果是：

~~~json
{
  "type": "getPostCount",
  "data": {
    "count": 0
  }
}
~~~

## 按需要启用

安装后，在 Hexo 的 _config.yml 里选择要生成的接口：

~~~yaml
hexo_info_api:
  allowOrigin: "*"
  enable:
    - getInfo
    - getPostCount
    - getPosts
    - getCategories
    - getTags
    - getLatestPost
  disable_default_api: false
~~~

默认的 /api/ 返回已开启接口列表，disable_default_api 可以关掉这个入口。每个接口对应 lib/api 下的一个模块，配置里没选的就不加载。

![配置决定启用哪些数据模块，未选择的模块不参与生成](https://image.im0o.top/2026/20261117104222472.webp "配置决定启用哪些数据模块，未选择的模块不参与生成")

## 生成 JSON 与本地访问

实现用的是 Hexo generator。模块读取 Hexo 的文章与分类数据，返回文件路径和 JSON 字符串，跟着站点一起生成。按文章路径查询的接口也是在构建时为已有文章生成对应的路径。

Hexo Server 这边另外注册了 server_middleware，为 /api/ 下的响应设置 JSON 类型和 allowOrigin 对应的 CORS 响应头。生成文件与本地开发服务器的响应头在这两处分别处理。

这个项目整理成了 npm 包，接口的数据结构也放在仓库 wiki 里，博客记录了最初的实现。

[npm](https://www.npmjs.com/package/hexo-info-api) · [源代码与接口文档](https://github.com/jz0ojiang/hexo-info-api) · [开发记录](https://blog.im0o.top/posts/d3bc8dff.html)

![同一份文章数据，在构建时生成静态页面与 JSON 文件](https://image.im0o.top/2026/20261117104227958.webp "同一份文章数据，在构建时生成静态页面与 JSON 文件")

