跳转到内容

LANrurugi 文档

LANraragi 的 Rust + React 重写版——自托管漫画/同人志库管理器,与现有 LANraragi 部署保持数据与 API 兼容。
  • 安装(Docker / NAS)——把 LANrurugi 跑起来,并让它读到你已有的库。
  • 快速开始——首次登录、扫描库、导入旧数据。
  • 用文档站测试 API——在浏览器里直接对你自己的实例发请求,以及它不生效时的处理方式。
  • 插件开发入门——写一个元数据/登录/下载插件。
  • API 参考——完整的 HTTP API:每个端点、参数、响应,以及可直接复制的命令行。

API 参考不是手写的。它由 crates/lanrurugi-api-docgen 从服务端自己的路由注册里生成,因此:

  • 服务端提供的每个端点都在里面,不会出现“代码里有、文档里没有”;
  • 它不会列出服务端其实不提供的端点;
  • 与 LANraragi 共有的端点,直接沿用 LANraragi 官方 OpenAPI 文档的字段级描述(路径前缀与鉴权部分除外);
  • 尚未写清请求/响应结构的端点会被明确标出,而不是被编造出一份看起来很像真的 schema。

CI 会在生成结果与代码不一致时直接失败,所以这份参考不会像手写文档那样慢慢过期。