**LrcApi技术文档**

LrcApi技术文档

LrcApi A Flask API For StreamMusic 项目地址: https://gitcode.com/gh_mirrors/lr/LrcApi

安装指南

系统要求

LrcApi适用于Python 3.10及以上版本的环境。确保您的系统已经安装了Python，并更新至相应版本。

获取源码

1. Git克隆: 如果您习惯使用Git，可以通过以下命令克隆项目到本地:

   git clone https://github.com/HisAtri/LrcApi.git
   

2. 直接下载: 也可以直接从GitHub页面下载ZIP压缩包，并解压。

安装依赖

在项目根目录下执行以下命令来安装必要的Python库:

pip install -r requirements.txt

项目的使用说明

运行应用

Python源码启动

1. 基本启动:

   python3 app.py
   

   默认监听28883端口，使用默认鉴权设置。

2. 自定义配置: 若想更改端口号或添加鉴权，使用以下命令:

   python3 app.py --port 8080 --auth 你的鉴权密钥
   

Docker部署

如果您更偏好容器化部署，使用下面的命令：

docker run -d -p 28883:28883 -e API_AUTH=你的鉴权密钥 hisatri/lrcapi:latest

这里 -e API_AUTH 设置鉴权密钥，-p 指定了宿主机与容器之间的端口映射。

访问API

• 歌词API: http://localhost:28883/lyrics
• JSON格式API: http://localhost:28883/jsonapi
• 封面API: http://localhost:28883/cover

二次开发与接口调用示例

对于开发者，你可以使用HTTP客户端如requests来调用API，比如修改歌曲标签的POST请求示例：

import requests
json_data = {"path":"/your/local/song.mp3", "title":"新标题"}
response = requests.post('http://localhost:28883/tag', json=json_data)
print("状态码:", response.status_code)
print("响应内容:", response.json())

项目API使用文档

• 歌词API: 提供歌曲的LRC歌词，支持通过歌曲ID或其他标识符查询。
• JSONAPI: 新版API，返回JSON格式的数据，适合现代前后端分离的应用。
• 封面API: 获取音乐专辑封面，通过歌曲ID或特定查询参数。

请求头鉴权

若设置了鉴权，请求必须包含Authorization或Authentication头部，值为你设定的鉴权密钥。

总结

LrcApi是一个灵活易用的Flask API服务，旨在为音乐应用提供歌词和封面信息。无论是个人开发者还是小型团队，都能够快速集成并利用此API提升用户体验。通过遵循提供的安装和使用指南，您可以轻松部署和自定义LrcApi，进一步扩展其功能满足个性化需求。记得在二次开发过程中遵循GPL-3.0许可证的规定哦！

---

该文档提供了一个全面的概览，从安装到运行，再到API的使用，帮助开发者快速上手LrcApi项目。希望对您有所帮助！

LrcApi A Flask API For StreamMusic 项目地址: https://gitcode.com/gh_mirrors/lr/LrcApi