Wallabag 客户端 API

提供与 Wallabag 服务器 API 交互的类型和函数。

关于

查看 文档 了解使用信息。

支持的 API 端点

除了 /api/*/list{,s} 外，所有 API 端点都已实现。除非有很好的理由，否则我不会计划实现对这些端点的支持。

• DELETE /api/annotations/{annotation}.{_format} 删除一个注释。
• PUT /api/annotations/{annotation}.{_format} 更新一个注释。
• GET /api/annotations/{entry}.{_format} 获取一个条目的注释。
• POST /api/annotations/{entry}.{_format} 创建一个新的注释。
• GET /api/entries.{_format} 获取所有条目。它可以按许多选项进行过滤。
• POST /api/entries.{_format} 创建一个条目。
• GET /api/entries/exists.{_format} 通过 URL 检查条目是否存在。
• DELETE /api/entries/list.{_format} 处理条目列表和删除 URL。
• POST /api/entries/lists.{_format} 处理条目列表和创建 URL。
• DELETE /api/entries/tags/list.{_format} 处理从条目中删除标签。
• POST /api/entries/tags/lists.{_format} 处理为条目添加标签。
• DELETE /api/entries/{entry}.{_format} 永久删除一个条目。
• GET /api/entries/{entry}.{_format} 获取单个条目。
• PATCH /api/entries/{entry}.{_format} 更改条目的多个属性。
• GET /api/entries/{entry}/export.{_format} 以预定义格式获取单个条目。
• PATCH /api/entries/{entry}/reload.{_format} 重新加载条目。
• GET /api/entries/{entry}/tags.{_format} 获取条目的所有标签。
• POST /api/entries/{entry}/tags.{_format} 向条目添加一个或多个标签。
• DELETE /api/entries/{entry}/tags/{tag}.{_format} 永久从一个条目中删除一个标签。
• DELETE /api/tag/label.{_format} 通过传递标签标签从每个条目中永久删除一个标签。
• GET /api/tags.{_format} 获取所有标签。
• 删除 /api/tags/label.{_format} 永久删除每个条目中的某些标签。
• 删除 /api/tags/{tag}.{_format} 通过传递标签 ID 永久删除每个条目中的一个标签。
• GET /api/user.{_format} 获取当前登录用户信息。
• PUT /api/user.{_format} 注册用户并创建客户端。
• GET /api/version.{_format} 获取版本号。

示例

提供了一些小示例。要使用这些示例，必须设置以下环境变量（用于身份验证）。例如

export WALLABAG_CLIENT_ID="client_id"
export WALLABAG_CLIENT_SECRET="client_secret"
export WALLABAG_USERNAME="username"
export WALLABAG_PASSWORD="password"
export WALLABAG_URL="https://framabag.org" # must not end with trailing slash

示例包括

• check_exists：检查是否有与提供的 URL 对应的条目。
• example_sandbox：一些（主要是）注释掉的小示例，用于手动测试... 好玩！
• get_entries：简单检索并调试打印所有条目。查看源代码以了解过滤选项。
• get_entries_page：示例获取不带自动处理分页的单页条目。
• save_url：将 URL 保存到服务器，成功时打印创建的条目。

贡献

请将您的评论、错误报告、功能请求和补丁发送到此公开邮件列表：~swalladge/[email protected] (存档)。

许可证

根据您选择的

• Apache 许可证 2.0 版
• MIT 许可证

。