文档页重整：在线调试环境和 Swagger UI 该用哪个

文档页重新整理过了：接口按小红书数据接口和蒲公英数据接口两个族分组，蒲公英不再挤在一个分类里，而是拆成博主基础数据、笔记案例、博主发现、笔记维度、内容广场、关键词分析六个子章节，目录里都能直接跳。

顺带把两个调试入口收进了同一页。这篇说明它们的区别，以及什么时候用哪个。

两个入口

在线调试环境（docs.rnote.dev）——独立的调试站点，界面按使用场景组织，适合第一次上手：你想知道某个接口返回什么样的数据，填个参数点一下就看到了。

Swagger UI（/docs）——由 OpenAPI 规范自动生成，和后端代码同源，永远和真实接口一致。适合写代码的时候：查某个参数的确切名字、类型、默认值和取值范围。

怎么选

最后一行值得展开：手写的文档会漂，自动生成的不会。如果你在别处看到一个接口而 Swagger 上没有，以 Swagger 为准。

免费测试 Key

不想先充值就想试，可以在后台购买源码页申请一把免费测试 Key：1 天有效、20 次/分钟、每日 100 次，每个账号仅限一把。拿到之后在 Demo 控制台点右上角 Authorize 粘进去，就能直接 Try it out。

超出频率或每日额度会返回 429，不是扣费——试用不会产生费用。

文档页还有什么

• 快速开始 / 认证方式 / 第一个请求——从注册到跑通第一个调用。
• 两族接口清单——41 个接口，每个带参数说明与示例。
• 响应格式 / 错误码 / 计费说明——接入时最常回头查的三节。
• 私有化部署——如果你更想把整套服务部署在自己机器上，这一节说明与托管 API 的区别。

开始使用

免费注册后即可申请测试 Key。接口清单见文档，价格见定价。