nas/MoviePilot
1
0
Fork 0
mirror of https://github.com/jxxghp/MoviePilot.git synced 2026-03-20 03:57:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update API key documentation to clarify retrieval methods in security.py and mcp-api.md

Browse Source
This commit is contained in:
jxxghp
2025-11-19 13:42:53 +08:00
parent 6123a1620e
commit b2d36c0e68
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/core/security.py
View File

@@ -261,7 +261,7 @@ def verify_apitoken(token: Annotated[str, Security(__get_api_token)]) -> str:
def verify_apikey(apikey: Annotated[str, Security(__get_api_key)]) -> str: def verify_apikey(apikey: Annotated[str, Security(__get_api_key)]) -> str:
""" """
使用 API Key 进行身份认证 使用 API Key 进行身份认证
:param apikey: API Key，从 URL 查询参数中获取 apikey=xxx :param apikey: API Key，从 URL 查询参数中获取 apikey=xxx，或请求头中获取 X-API-KEY=xxx
:return: 返回校验通过的 API Key :return: 返回校验通过的 API Key
""" """
return __verify_key(apikey, settings.API_TOKEN, "apikey") return __verify_key(apikey, settings.API_TOKEN, "apikey")

2
docs/mcp-api.md
View File

@@ -12,7 +12,7 @@ MoviePilot的智能体工具已通过HTTP API暴露，可以通过RESTful API调
获取所有可用的MCP工具列表。 获取所有可用的MCP工具列表。
**认证**: 需要API KEY，?api_key=MoviePilot设置中的API Key **认证**: 需要API KEY，从 URL 查询参数中获取 `apikey=xxx`，或请求头中获取 `X-API-KEY`
**响应示例**: **响应示例**:
```json ```json