data_api

package
v1.3.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 1, 2026 License: MIT Imports: 47 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DeleteBookCache added in v1.2.11 

func DeleteBookCache(c echo.Context) error

DeleteBookCache 删除书籍的元数据和缓存文件 示例 URL： /api/books/{id}/cache 相关参数： id：书籍的ID，必须参数 &id=2b17a13 delete_metadata: 是否删除元数据JSON文件，可选参数，默认 true &delete_metadata=true delete_cover: 是否删除封面缓存文件，可选参数，默认 true &delete_cover=true delete_image_cache: 是否删除图片缓存目录，可选参数，默认 true &delete_image_cache=true

func DeleteBookmark added in v1.2.12 

func DeleteBookmark(c echo.Context) error

DeleteBookmark 删除特定书签的 API 处理函数 DELETE /api/bookmarks 参数：book_id, mark_type, page_index

func DeviceCookie added in v1.3.5 

func DeviceCookie(next echo.HandlerFunc) echo.HandlerFunc

DeviceCookie 在页面响应时建立设备标识，供同一浏览器的多个标签页共享。

func DownloadEpub added in v1.2.11 

func DownloadEpub(c echo.Context) error

DownloadEpub 将书籍转换为 EPUB 格式下载 示例 URL： http://127.0.0.1:1234/api/download-epub?id=2b17a13 相关参数： id：书籍的ID，必须参数 &id=2b17a13

func DownloadZip added in v1.2.11 

func DownloadZip(c echo.Context) error

DownloadZip 将 TypeDir 类型的书籍打包为 zip 文件下载 示例 URL： http://127.0.0.1:1234/api/download-zip?id=2b17a13 相关参数： id：书籍的ID，必须参数 &id=2b17a13

func GetAllBookmarks added in v1.1.8 

func GetAllBookmarks(c echo.Context) error

GetAllBookmarks 获取所有书签的 API 处理函数

func GetBook 

func GetBook(c echo.Context) error

GetBook 相关参数： id： 书籍的ID，必须项目 &id=2b17a130 sort_by：页面排序方法，可选 &sort_by=filename 示例 URL： http://127.0.0.1:1234/api/books/{id}?sort_by=filename

func GetBooks added in v1.3.5 

func GetBooks(c echo.Context) error

GetBooks 返回当前书籍索引；完整分页信息通过单本资源获取。

func GetConnections added in v1.3.5 

func GetConnections(c echo.Context) error

GetConnections 返回当前在线连接和登录用户、浏览器设备数量。

func GetCover added in v1.2.0 

func GetCover(c echo.Context) error

GetCover 获取书籍封面 相关参数： id：书籍的ID，必须参数 &id=2B17a resize_height：可选参数，指定封面高度，默认值为352 &resize_height=500 示例 URL： http://127.0.0.1:1234/api/get-cover?id=2b17a13 示例 URL（自定义高度）： http://127.0.0.1:1234/api/get-cover?id=2b17a13&resize_height=500

func GetFile 

func GetFile(c echo.Context) error

GetFile 示例 URL： 127.0.0.1:1234/get_file?id=2b17a13&filename=1.jpg 缩放文件，会转化为jpeg：http://127.0.0.1:1234/api/get-file?id=2b17a13&resize_width=300&resize_height=400&id=597e06&filename=01.jpeg 相关参数： id：书籍的ID，必须参数 &id=2B17a filename:获取的文件名，必须参数 &filename=01.jpg 可选参数： resize_width:指定宽度，缩放图片 &resize_width=300 resize_height:指定高度，缩放图片 &resize_height=300 resize_max_width:指定宽度上限，图片宽度大于这个上限时缩小图片 &resize_max_width=740 resize_max_height:指定高度上限，图片高度大于这个上限时缩小图片 &resize_max_height=300 auto_crop:自动切白边，数字是切白边的阈值，范围是0~100 &auto_crop=10 gray:黑白化 &gray=true blurhash:获取对应图片的blurhash，不是原始图片 &blurhash=3 blurhash_image:获取对应图片的blurhash图片，不是原始图片 &blurhash_image=3 base64:返回Base64编码的图片 &base64=true

func GetGeneratedImage 

func GetGeneratedImage(c echo.Context) error

func GetParentBook 

func GetParentBook(c echo.Context) error

func GetPublicInfo added in v1.3.7 

func GetPublicInfo(c echo.Context) error

GetPublicInfo 只公开连接协商必需的信息，不包含书库、地址、设备或流量。

func GetQrcode 

func GetQrcode(c echo.Context) error

GetQrcode 下载服务器配置

func GetRawFile 

func GetRawFile(c echo.Context) error

GetRawFile 输出书籍原始文件；本地/VFS/远端 Comigo 都保留 Range，供音视频拖动播放。

func GetReadingHistory added in v1.2.11 

func GetReadingHistory(c echo.Context) error

GetReadingHistory 获取阅读历史的 API 处理函数 参数:

  • limit: 限制返回数量 (drawer用，如10)，优先级高于分页参数
  • page: 页码 (设置页面分页用，默认1)
  • page_size: 每页数量 (默认20)

func GetRegFile 

func GetRegFile(c echo.Context) error

GetRegFile 注册表文件

func GetServerInfoHandler 

func GetServerInfoHandler(c echo.Context) error

GetServerInfoHandler 获取服务器信息的API处理函数

func GetServerTrafficHandler added in v1.3.5 

func GetServerTrafficHandler(c echo.Context) error

GetServerTrafficHandler 为桌面面板提供轻量快照，避免高频查询系统信息和 Tailscale。

func GetServerUpdateHandler added in v1.3.5 

func GetServerUpdateHandler(c echo.Context) error

GetServerUpdateHandler 只检查版本，不下载或执行更新。

func GetStore added in v1.3.5 

func GetStore(c echo.Context) error

GetStore 返回指定书库的状态及书籍索引。

func GetStores added in v1.2.4 

func GetStores(c echo.Context) error

GetStores 返回配置中的书库集合。

func GetTailscaleStatus 

func GetTailscaleStatus(c echo.Context) error

GetTailscaleStatus 处理Tailscale网络的身份信息查询请求

func GetTailscaleStatusSSE added in v1.2.37 

func GetTailscaleStatusSSE(c echo.Context) error

GetTailscaleStatusSSE 通过 SSE 推送 Tailscale 状态，替代设置页里的轮询。

func GetTopOfShelfInfo 

func GetTopOfShelfInfo(c echo.Context) error

func Healthz added in v1.2.25 

func Healthz(c echo.Context) error

Healthz 用于嵌入式宿主探测本地 HTTP 服务是否已可用。

func ParseHexColor 

func ParseHexColor(s string) (c color.RGBA, err error)

ParseHexColor 用于解析如 "#FFFFFF" 或 "FFFFFF" 格式的十六进制颜色字符串

func StoreBookmark 

func StoreBookmark(c echo.Context) error

func StoreURLFromID added in v1.3.5 

func StoreURLFromID(id string) (string, error)

StoreURLFromID 只允许访问已配置的书库，不能通过刷新接口扫描任意路径。

func TrackConnection added in v1.3.5 

func TrackConnection(next echo.HandlerFunc) echo.HandlerFunc

TrackConnection 只登记通过认证的 SSE/WebSocket 连接，断开时立即移除。

Types

type Connection added in v1.3.5 

type Connection struct {
	ID          string    `json:"id"`
	Device      string    `json:"device"`
	User        string    `json:"user"`
	IP          string    `json:"ip"`
	UserAgent   string    `json:"userAgent"`
	ConnectedAt time.Time `json:"connectedAt"`
}

Connection 表示一个实时连接；设备按浏览器 Cookie 去重，用户按登录账号去重。

type ReadingHistoryResponse added in v1.2.11 

type ReadingHistoryResponse struct {
	Items      []model.BookinfoWithBookMark `json:"items"`       // 阅读历史列表
	TotalCount int                          `json:"total_count"` // 总数量
	Page       int                          `json:"page"`        // 当前页码
	PageSize   int                          `json:"page_size"`   // 每页数量
	TotalPages int                          `json:"total_pages"` // 总页数
}

ReadingHistoryResponse 阅读历史响应结构

type StoreInfo added in v1.2.4 

type StoreInfo struct {
	ID        string `json:"id"`
	URL       string `json:"url"`
	Name      string `json:"name"`
	Remote    bool   `json:"remote"`
	Exists    *bool  `json:"exists"`
	BookCount int    `json:"bookCount"`
}

StoreInfo 书库资源；ID 使用配置 URL 的 base64url 编码，远程 URL 不转成本地路径。

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.