PicaComic 中文文档 下载 App

制作自定义漫画源基础 · 接口概览与第一个源

先说明

本节是编写自定义漫画源的入门概览,不是完整的 API 参考。完整接口列表以官方仓库的 doc/comic_source.md 为准,因为接口随版本变化较快。

漫画源脚本的结构

一个漫画源脚本本质上是一段 JavaScript,它需要实现一套约定的接口函数。应用在运行时会根据调用场景执行对应的接口。

最简漫画源需要实现的接口(3.1.0+ 格式):

可选接口:搜索、收藏、历史记录、更新检测等。

HTTP 请求

漫画源不能直接调用浏览器的 fetch 或 XMLHttpRequest——所有网络请求必须通过应用提供的接口。应用会在 JS 沙箱里注入一个 http 对象,提供:

这样做有两个好处:

  1. 应用可以统一处理 Cookie、代理和 Cloudflare 验证
  2. 沙箱安全——漫画源不能绕过应用直接建立连接

HTML/JSON 解析

漫画源需要从网页中提取漫画信息。应用提供了解析工具:

输出格式约定

每个接口函数的返回值必须是应用能理解的格式。比如浏览接口返回的漫画列表,每一项需要包含:

返回格式错误会导致应用崩溃或显示异常——这也是格式校验的重要性所在。

调试建议

编写自定义漫画源时,应用提供了日志输出接口 log()。3.1.1 版本修复了 log 只能接收 string 的问题,现在可以直接 log(someObject) 并自动序列化为字符串。

日志查看位置取决于平台:

建议先用最简单的接口跑通——比如先写浏览接口返回固定数据,确认应用能正确显示列表,再逐步添加详情、阅读等接口。