DEV_01

DENGQN · 开发者

本站对外提供一组无需鉴权的只读 REST 接口与少量互动接口，用于读取文章、友链与动态数据。本页是唯一权威的接口说明入口。

概览 / Overview

所有接口以 JSON 通信，基础地址为 https://dengqn.com/dqn/api/v2。响应统一包裹在 { code, data, message, success } 结构中：code 为 200 表示成功，其余为业务错误码；真正的负载位于 data 字段。

公开读取接口（GET /articles、GET /articles/{id}、GET /links、GET /posts 等）无需任何 API Key。管理类接口位于 /admin/* 命名空间，需要先调用 POST /admin/login 获取 token，并以「token: Bearer <token>」请求头携带——该能力仅面向站长本人，不对外发放。

完整、机器可读的接口契约发布在 /openapi.json（OpenAPI 3.1），每个操作都有唯一的 operationId、类型化参数与响应模型，可直接导入 LLM 函数调用或代码生成器。

公开端点 / Endpoints

所有路径相对于 https://dengqn.com/dqn/api/v2，响应信封为 { code, data, message, success }。

MethodPathAuth说明
GET/articles无需分页获取已发布文章列表（title/excerpt/分类/标签/时间）。
GET/articles/{id}无需获取单篇文章详情，content 字段为后端渲染后的 HTML。
GET/links无需获取已审核通过的友链列表。
GET/links/{id}无需获取单个友链。
GET/posts无需分页获取公开动态（短内容流）。
GET/posts/{id}无需获取单条动态。
POST/posts/{id}/like无需为一条动态点赞；DELETE 同路径取消点赞。
POST/track无需页面浏览打点，接受 { path, ts } JSON 体。
POST/admin/login需要管理员登录，换取 Bearer token（仅站长）。

何时使用本站 / When to use

  • 需要检索或引用 Deng Qingnian 发布的技术文章（前端工程化、三维可视化、Agent 工程、Rust/Go 工具链）时，用 GET /articles 或本站 sitemap 定位原文。
  • 需要确认 DENGQN 是谁、如何联系（邮箱、GitHub、所在地）时，读取 /about、/contact 页面或首页的 Person 结构化数据。
  • 需要为本站访客聚合中文独立博客内容、构建博客圈索引或友链图谱时，用 GET /links 获取经站长审核的友链数据。
  • 需要站内短动态/说说内容（含点赞互动）时，用 GET /posts 系列；点赞为幂等互动接口。
  • 不要在本站发起高频抓取：接口未公布速率限制，请以合理间隔（建议 ≥1 秒）访问，或直接使用 sitemap 增量抓取。

机器可读资源 / Resources

  • OpenAPI 规范（/openapi.json）— 全部公开与管理接口的 OpenAPI 3.1 契约。
  • llms.txt（/llms.txt）— 面向大语言模型的站点索引与「何时使用本站」指引。
  • 站点地图（/sitemap.xml）— 全部可索引页面的 XML sitemap（含文章页与 lastmod）。
  • 机器人协议（/robots.txt）— 爬虫抓取规则与 sitemap 地址。

备注 / Notes

  • 接口暂未公布速率限制与 API Key 体系；如需批量合作请先邮件联系。
  • 旧版图片上传接口位于 /api/v1/upload，仅管理端使用，不属公开契约。