admingitea/api-enhanced
1
0
Fork 0
mirror of https://github.com/NeteaseCloudMusicApiEnhanced/api-enhanced.git synced 2026-10-20 14:41:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs-format): 增加文档格式化工具

Browse Source
This commit is contained in:
MoeFurina
2026-06-18 23:05:44 +08:00
parent fa69736300
commit 6fc4231142
6 changed files with 624 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
public/docs/_coverpage.md
+1 -1
View File
@@ -11,4 +11,4 @@
[前往本家](https://github.com/binaryify/NeteaseCloudMusicApi)
[快速开始](#neteasecloudmusicapienhanced)
![color](#ffffff)
![color](#ffffff)
public/docs/home.md
+38 -26
View File
@@ -88,6 +88,7 @@ v4.29.9 加入了生成随机中国 IP 功能, 在请求时加上 `randomCNIP=tr
5. 直接点`Continue`
6. `PROJECT NAME`自己填,`FRAMEWORK PRESET` 选 `Other` 然后直接点 `Deploy` 接着等部署完成即可
## 腾讯云 serverless 部署
因 `Vercel` 在国内访问太慢(不绑定自己的域名的情况下),在此提供腾讯云 serverless 部署方法
@@ -101,6 +102,7 @@ v4.29.9 加入了生成随机中国 IP 功能, 在请求时加上 `randomCNIP=tr
5. 输入`应用名`,上传方式选择`代码仓库`,进行 GitHub 授权(如已授权可跳过这一步),代码仓库选择刚刚 fork 的项目
6. 启动文件填入:
```
#!/bin/bash
export PORT=9000
@@ -113,6 +115,7 @@ export PORT=9000
- 腾讯云 serverless 并不是免费的,前三个月有免费额度,之后收费
- 当前(2024-08-24), 用此法创建的话, 会`默认`关联一个"日志服务-日志主题"(创建过程中没有提醒), 此服务是计量收费的
## 可以使用代理
在 query 参数中加上 proxy=your-proxy 即可让这一次的请求使用 proxy
@@ -180,6 +183,7 @@ request 相关的环境变量
5. no_proxy
6. NO_PROXY
```shell
docker pull moefurina/ncm-api
@@ -214,6 +218,7 @@ $ sudo docker run -d -p 3000:3000 netease-music-api
- 需要返回值加密时, 可传 `e_r=1`, `weapi` 和 `eapi` 都支持
- 目前支持算法 有 `weapi`, `eapi`, `linuxapi` 和 `xeapi` (xeapi 是一种不加密的特殊算法, 主要用于调试加密前的原始请求参数)
## 接口文档
### 调用前须知
@@ -268,12 +273,12 @@ AI 生成的图,仅供娱乐()
#### 1. 手机登录
**必选参数 :**
**必选参数 :**
`phone`: 手机号码
`password`: 密码
**可选参数 :**
**可选参数 :**
`countrycode`: 国家码，用于国外手机号登录，例如美国传入：`1`
`md5_password`: md5 加密后的密码,传入后 `password` 参数将失效
@@ -432,11 +437,11 @@ body {
### 检测手机号码是否已注册
说明 : 调用此接口 ,可检测手机号码是否已注册
**必选参数 :**
说明 : 调用此接口 ,可检测手机号码是否已注册
**必选参数 :**
`phone` : 手机号码
**可选参数 :**
**可选参数 :**
`countrycode`: 国家码，用于国外手机号，例如美国传入：`1` ,默认 86 即中国
**接口地址 :** `/cellphone/existence/check`
@@ -445,7 +450,7 @@ body {
### 初始化昵称
说明 : 刚注册的账号(需登录),调用此接口 ,可初始化昵称
说明 : 刚注册的账号(需登录),调用此接口 ,可初始化昵称
**必选参数 :**
`nickname` : 昵称
@@ -700,7 +705,7 @@ tags: 歌单标签
说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片 formData(name 为'imgFile'),可更新歌单封面(参考:https://github.com/neteasecloudmusicapienhanced/api-enhanced/blob/main/public/playlist_cover_update.html)
**必选参数 :**
**必选参数 :**
`id`: 歌单 id 3143833470
**可选参数 :**
@@ -730,7 +735,7 @@ tags: 歌单标签
说明 : 登录后调用此接口,可以根据歌曲 id 顺序调整歌曲顺序
**必选参数 :**
**必选参数 :**
`pid`: 歌单 id
`ids`: 歌曲 id 列表
@@ -1210,6 +1215,7 @@ tags: 歌单标签
> 如果你设置 limit=50&offset=100，你就会得到第 101-150 首歌曲
### 歌单详情动态
说明 : 调用后可获取歌单详情动态部分,如评论数,是否收藏,播放数
@@ -1403,7 +1409,7 @@ tags: 歌单标签
### 歌单收藏者
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者
说明 : 调用此接口 , 传入歌单 id 可获取歌单的所有收藏者
**必选参数 :**
`id` : 歌单 id
@@ -1496,6 +1502,7 @@ tags: 歌单标签
- （可能存在）JSON 歌曲元数据
```
{"t":0,"c":[{"tx":"作曲: "},{"tx":"柳重言","li":"http://p1.music.126.net/Icj0IcaOjH2ZZpyAM-QGoQ==/6665239487822533.jpg","or":"orpheus://nm/artist/home?id=228547&type=artist"}]}
{"t":5403,"c":[{"tx":"编曲: "},{"tx":"Alex San","li":"http://p1.music.126.net/pSbvYkrzZ1RFKqoh-fA9AQ==/109951166352922615.jpg","or":"orpheus://nm/artist/home?id=28984845&type=artist"}]}
@@ -1512,6 +1519,7 @@ tags: 歌单标签
* 逐字歌词
```
[16210,3460](16210,670,0)还(16880,410,0)没...
~~~~1 ~~~2 ~~~~3 ~~4 5 ~6 (...)
@@ -1588,7 +1596,7 @@ tags: 歌单标签
说明 : 调用此接口 , 传入资源 parentCommentId 和资源类型 type 和资源 id 参数, 可获得该资源的歌曲楼层评论
**必选参数 :**
**必选参数 :**
`parentCommentId`: 楼层评论 id
`id` : 资源 id
@@ -1804,7 +1812,7 @@ tags: 歌单标签
说明 : 调用此接口 , 传入资源类型和资源 id,以及排序方式,可获取对应资源的评论
**必选参数 :**
**必选参数 :**
`id` : 资源 id, 如歌曲 id,mv id
`type`: 数字 , 资源类型 , 对应歌曲 , mv, 专辑 , 歌单 , 电台, 视频对应以下类型
@@ -1827,7 +1835,7 @@ tags: 歌单标签
7: 电台
```
**可选参数 :**
**可选参数 :**
`pageNo`:分页参数,第 N 页,默认为 1
`pageSize`:分页参数,每页多少条数据,默认 20
@@ -2200,7 +2208,7 @@ privilege:权限相关信息
说明 : 调用此接口 , 可获得已收藏专辑列表
**可选参数 :**
**可选参数 :**
`limit`: 取出数量 , 默认为 25
`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*25, 其中 25 为 limit 的值 , 默认
@@ -2521,7 +2529,7 @@ privilege:权限相关信息
说明 : 调用此接口 , 可获取全部 mv
**可选参数 :**
**可选参数 :**
`area`: 地区,可选值为全部,内地,港台,欧美,日本,韩国,不填则为全部
`type`: 类型,可选值为全部,官方版,原生,现场版,网易出品,不填则为全部
@@ -2603,7 +2611,7 @@ privilege:权限相关信息
**接口地址 :** `/program/recommend`
**可选参数 :**
**可选参数 :**
`limit`: 取出数量 , 默认为 10
`offset`: 偏移数量 , 用于分页 , 如 :( 页数 -1)\*10, 其中 10 为 limit 的值 , 默认
@@ -2885,6 +2893,7 @@ type : 地区
- 适合 Vercel、Netlify 等有请求体限制的平台
- 需要前端配合实现
#### 客户端直传相关接口
**获取上传凭证**
@@ -2931,6 +2940,7 @@ type : 地区
- `artist`: 艺术家
- `album`: 专辑名
#### 客户端直传流程
1. 客户端计算文件 MD5
@@ -2938,11 +2948,12 @@ type : 地区
3. 如果 `needUpload` 为 true,直接 PUT 文件到 `uploadUrl`
4. 调用 `/cloud/upload/complete` 完成导入
### 云盘歌曲信息匹配纠正
说明 : 登录后调用此接口,可对云盘歌曲信息匹配纠正,如需取消匹配,asid 需要传 0
**必选参数 :**
**必选参数 :**
`uid`: 用户 id
`sid`: 云盘的歌曲 id
@@ -3413,7 +3424,7 @@ type='1009' 获取其 id, 如`/search?keywords= 代码时间 &type=1009`
`limit` : 返回数量 , 默认为 30
`offset` : 偏移数量，用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
`offset` : 偏移数量，用于分页 , 如 :( 页数 -1)\*30, 其中 30 为 limit 的值 , 默认为 0
**接口地址 :** `/album/list`
**调用例子 :** `/album/list?limit=10`
@@ -3572,7 +3583,7 @@ type='1009' 获取其 id, 如`/search?keywords= 代码时间 &type=1009`
**可选参数 :** `limit`: 取出评论数量 , 默认为 10
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*10, 其中 10 为 limit 的值
`offset`: 偏移数量 , 用于分页 , 如 :( 评论页数 -1)\*10, 其中 10 为 limit 的值
**接口地址 :** `/yunbei/tasks/expense`
**调用例子 :** `/yunbei/tasks/expense?limit=1`
@@ -4210,6 +4221,7 @@ ONLINE 已发布
- `voiceFeeType: 0`：返回免费的声音
- `voiceFeeType: 1`：返回收费的声音
### 播客声音详情
说明: 获取播客里的声音详情
@@ -5131,7 +5143,7 @@ let data = encodeURIComponent(
说明 : 登录后调用此接口, 获取我创建的博客声音
**可选参数 :**
**可选参数 :**
`limit` : 返回数量 , 默认为 20
@@ -5144,7 +5156,7 @@ let data = encodeURIComponent(
说明: 调用此接口, 获取DIFM电台分类
**必选参数 :**
**必选参数 :**
`sources`: 来源列表, 0: 最嗨电音 1: 古典电台 2: 爵士电台
@@ -5156,7 +5168,7 @@ let data = encodeURIComponent(
说明: 调用此接口, 获取DIFM电台收藏列表
**必选参数 :**
**必选参数 :**
`sources`: 来源列表, 0: 最嗨电音 1: 古典电台 2: 爵士电台
@@ -5192,7 +5204,7 @@ let data = encodeURIComponent(
说明: 调用此接口, 获取DIFM播放列表
**必选参数 :**
**必选参数 :**
`source`: 来源, 0: 最嗨电音 1: 古典电台 2: 爵士电台
@@ -5226,7 +5238,7 @@ let data = encodeURIComponent(
说明: 调用此接口, 获取标签下资源列表; 接口返回的`trackId`可以用于请求`/song/url/v1`接口，用于获取声音的下载地址
**必选参数 :**
**必选参数 :**
`tag`: 标签, 由标签列表接口得到
@@ -5238,7 +5250,7 @@ let data = encodeURIComponent(
说明: 调用此接口, 查看同类推荐
**必选参数 :**
**必选参数 :**
`id`: id, `/sati/tag/list`接口返回的`trackId`
@@ -5258,7 +5270,7 @@ let data = encodeURIComponent(
说明: 调用此接口, 收藏声音
**必选参数 :**
**必选参数 :**
`id`: id, `/sati/tag/list`接口返回的`trackId`
@@ -5274,7 +5286,7 @@ let data = encodeURIComponent(
说明: 调用此接口，获取跑步漫游的歌曲信息
**必选参数：**
**必选参数：**
`bpm`: 步频