阅览 Public Book Query

接口列表 / 参数说明 / 返回结构

公开接口一览

这里集中列出搜索、详情、关联、ISBN 与统计接口，方便你快速查看请求参数、返回字段以及统一响应结构。

统一响应 envelope

code number

业务状态码，成功时为 200

message string

响应消息

data object

接口实际返回数据

timestamp number

服务端响应时间戳

path string

命中的接口路径

说明

  • 所有接口都返回统一 envelope，页面展示的 response fields 只描述 data 字段。
  • 公开站点默认匿名访问；第三方调用方可按需在请求头中携带 X-API-Key。
  • 搜索、详情、关联、ISBN 与统计接口都集中在同一页，便于快速对照和联调。

curl -G "https://open-api.iyuelan.cn/search/query" \

--data-urlencode "keyword=三体" \

--data-urlencode "type=book" \

--data-urlencode "page=1" \

--data-urlencode "pageSize=20"

接口分组

通用搜索

1 endpoints
GET /search/query

通用关键词检索（图书/作者/出版社/丛书）

SearchResponse data

参数

keyword query required

搜索关键词

string

type query

实体类型过滤

all | book | author | publisher | series

page query

页码（>=1）

number

pageSize query

每页数量（1-50）

number

data 字段结构

keyword string required

原始搜索关键词

type all | book | author | publisher | series required

当前搜索类型

page number required

当前页码

pageSize number required

每页数量

total number required

总命中数

totalPages number required

总页数

items EntityResponseItemDto[] required

结构化实体列表，每项包含 entity_type、entity_id、entity

接口分组

实体查询

7 endpoints
GET /entities/{entityType}/{entityId}

按实体类型和实体 ID 查询详情

EntityResponseItemDto

参数

entityType path required

实体类型

book | author | publisher | series

entityId path required

实体 ID

string

data 字段结构

entity_type book | author | publisher | series required

实体类型

entity_id string required

实体 ID

entity Record<string, unknown> required

结构化实体详情，按 entity_type 返回图书/作者/出版社/丛书对应字段

GET /entities/book/{entityId}/authors

查询图书关联作者列表

RelatedEntityListResponseDto

参数

entityId path required

图书 ID

string

page query

页码

number

pageSize query

每页数量

number

data 字段结构

entity_type book | author | publisher | series required

主实体类型

related_type book | author | publisher | series required

关联实体类型

page number required

当前页码

pageSize number required

每页数量

total number required

总条数

totalPages number required

总页数

items Record<string, unknown>[] required

关联实体列表，元素字段取决于 related_type

GET /entities/book/{entityId}/publishers

查询图书关联出版社列表

RelatedEntityListResponseDto

参数

entityId path required

图书 ID

string

page query

页码

number

pageSize query

每页数量

number

data 字段结构

entity_type book | author | publisher | series required

主实体类型

related_type book | author | publisher | series required

关联实体类型

page number required

当前页码

pageSize number required

每页数量

total number required

总条数

totalPages number required

总页数

items Record<string, unknown>[] required

关联实体列表，元素字段取决于 related_type

GET /entities/book/{entityId}/series

查询图书关联丛书列表

RelatedEntityListResponseDto

参数

entityId path required

图书 ID

string

page query

页码

number

pageSize query

每页数量

number

data 字段结构

entity_type book | author | publisher | series required

主实体类型

related_type book | author | publisher | series required

关联实体类型

page number required

当前页码

pageSize number required

每页数量

total number required

总条数

totalPages number required

总页数

items Record<string, unknown>[] required

关联实体列表，元素字段取决于 related_type

GET /entities/author/{entityId}/books

查询作者关联图书列表

RelatedEntityListResponseDto

参数

entityId path required

作者 ID

string

page query

页码

number

pageSize query

每页数量

number

data 字段结构

entity_type book | author | publisher | series required

主实体类型

related_type book | author | publisher | series required

关联实体类型

page number required

当前页码

pageSize number required

每页数量

total number required

总条数

totalPages number required

总页数

items Record<string, unknown>[] required

关联实体列表，元素字段取决于 related_type

GET /entities/publisher/{entityId}/books

查询出版社关联图书列表

RelatedEntityListResponseDto

参数

entityId path required

出版社 ID

string

page query

页码

number

pageSize query

每页数量

number

data 字段结构

entity_type book | author | publisher | series required

主实体类型

related_type book | author | publisher | series required

关联实体类型

page number required

当前页码

pageSize number required

每页数量

total number required

总条数

totalPages number required

总页数

items Record<string, unknown>[] required

关联实体列表，元素字段取决于 related_type

GET /entities/series/{entityId}/books

查询丛书关联图书列表

RelatedEntityListResponseDto

参数

entityId path required

丛书 ID

string

page query

页码

number

pageSize query

每页数量

number

data 字段结构

entity_type book | author | publisher | series required

主实体类型

related_type book | author | publisher | series required

关联实体类型

page number required

当前页码

pageSize number required

每页数量

total number required

总条数

totalPages number required

总页数

items Record<string, unknown>[] required

关联实体列表，元素字段取决于 related_type

接口分组

ISBN 查询

1 endpoints
GET /isbn/query

通过 ISBN 查询图书详情（三方）

BookDetailDto

参数

isbn query required

ISBN 号码

string

data 字段结构

id string required

图书 ID

isbn string

ISBN

douban_id string

豆瓣 ID

title string required

书名

subtitle string

副标题

original_title string

原作名

authors AuthorBriefDto[]

作者列表

publishers PublisherBriefDto[]

出版社列表

publish_date string

出版日期

pages number

页数

price string

定价

binding string

装帧

series SeriesBriefDto[]

丛书列表

summary string

内容简介

catalog string

目录

cover_url string

封面 URL

douban_rating number

豆瓣评分

douban_rating_count number

豆瓣评分人数

tags TagBriefDto[]

标签列表

producers ProducerBriefDto[]

出品方列表

created_at string required

创建时间

updated_at string required

更新时间

接口分组

数据统计

1 endpoints
GET /statistics/overview

获取系统数据统计快照

StatisticsOverview data

参数

当前接口没有额外参数。

data 字段结构

available boolean required

统计快照是否可用

generatedAt string | null required

统计快照生成时间

generatedAtTimestamp number | null required

统计快照生成时间戳

metrics Record<string, number> | null required

按指标名聚合的系统统计数据

接口分组

系统状态

1 endpoints
GET /health

健康检查

object

参数

当前接口没有额外参数。

data 字段结构