mirror of
https://github.com/jxxghp/MoviePilot-Plugins.git
synced 2026-05-24 07:26:52 +00:00
29 lines
1.3 KiB
Markdown
29 lines
1.3 KiB
Markdown
# 如何扩展推荐功能的媒体数据源？
|
||
|
||
返回 [README](../../README.md) | [FAQ 索引](../FAQ.md)
|
||
|
||
**（仅支持 `v2.2.8+` 版本）**
|
||
- 实现`ChainEventType.RecommendSource`链式事件响应，将额外的媒体数据源塞入事件数据`extra_sources`数组中（注意：如果事件中已经有其它数据源，需要叠加而不是替换，避免影响其它插件塞入的数据）
|
||
|
||
- `name`：数据源名称
|
||
- `api_path`：数据获取API相对路径，需要在插件中实现API接口功能，GET模式接收过滤参数（注意：page参数默认需要有），返回`List[schemas.MediaInfo])`格式数据，参考`app/api/endpoints/recommend.py` 中的 `tmdb_trending`。
|
||
|
||
```python
|
||
class RecommendMediaSource(BaseModel):
|
||
"""
|
||
推荐媒体数据源的基类
|
||
"""
|
||
name: str = Field(..., description="数据源名称")
|
||
api_path: str = Field(..., description="媒体数据源API地址")
|
||
|
||
class RecommendSourceEventData(ChainEventData):
|
||
"""
|
||
RecommendSource 事件的数据模型
|
||
Attributes:
|
||
# 输出参数
|
||
extra_sources (List[RecommendMediaSource]): 额外媒体数据源
|
||
"""
|
||
# 输出参数
|
||
extra_sources: List[RecommendMediaSource] = Field(default_factory=list, description="额外媒体数据源")
|
||
```
|