refactor(api)!: 平台 id 改两字母短码——qian→bd、joox→jx、5sing→5s、bili→bl
对外 id 统一为两字母短码,与既有的 kw/kg/tx/wy/qs/xm/me/qt/lr 对齐; migu 与 apple 保持原样(Apple Music 没有自然的短码)。 **破坏性变更**:id 出现在所有 URL、/sources 返回、OpenAPI 示例以及 data/auth.json 的凭据键里,这四个平台已存的登录态会失效,需重新登录。 - sdk/index.ts:id 与 supportQuality 映射键 - sdk/types.ts:Source 联合类型 - src/routes.ts 与 routes-login.ts:路由路径与 schema 描述 (/login/bili/qr → /login/bl/qr 等)、/login/status 的响应键 - test/smoke-test.ts、README.md、docs/API.md 同步 有意未改:sdk 目录与文件名仍用平台名(sdk/qian/、sdk/apis/joox.ts …), 规则定为「目录=平台名,id=对外短码」,映射只在 SUPPORTED_SOURCES 一处声明。 域名与正则(joox.com、5sing.kugou.com、/joox\.com\//)、jooxSign 等标识符、 错误文案里的中文平台名、以及 kg 榜单名(含「joox本地热歌榜」)全部保持原样—— 它们只是恰好含平台名,并不是 id。 验证:typecheck ✓、pnpm test 112/112 ✓;另起临时实例实证 /sources 与 /login/status 的新 id 与展示名,新旧 id 均无残留。
This commit is contained in:
1 parent
14f7295fd4
commit
3381e9b906
33 files changed
+155
-155
No files matched your search
+11
-11
@@ -425,10 +425,10 @@ export const loginRoutes = async(fastify) => {
|
||||
|
||||
// ---------- 哔哩哔哩 ----------
|
||||
|
||||
fastify.post('/login/bili/qr', {
|
||||
fastify.post('/login/bl/qr', {
|
||||
schema: {
|
||||
summary: '获取哔哩哔哩扫码登录二维码',
|
||||
description: '用 B站 App 扫码后轮询 /login/bili/qr/check 完成登录。返回 key 需原样回传,qrimg 为 data URL 可直接展示。',
|
||||
description: '用 B站 App 扫码后轮询 /login/bl/qr/check 完成登录。返回 key 需原样回传,qrimg 为 data URL 可直接展示。',
|
||||
tags: ['登录'],
|
||||
},
|
||||
}, async(request, reply) => {
|
||||
@@ -439,7 +439,7 @@ export const loginRoutes = async(fastify) => {
|
||||
}
|
||||
})
|
||||
|
||||
fastify.post('/login/bili/qr/check', {
|
||||
fastify.post('/login/bl/qr/check', {
|
||||
schema: {
|
||||
summary: '轮询哔哩哔哩扫码状态',
|
||||
description: 'status:waiting 等待扫码 / scanned 已扫码待确认 / success 登录成功(自动保存凭据并返回账号资料)' +
|
||||
@@ -455,10 +455,10 @@ export const loginRoutes = async(fastify) => {
|
||||
}
|
||||
})
|
||||
|
||||
fastify.delete('/login/bili', {
|
||||
fastify.delete('/login/bl', {
|
||||
schema: { summary: '退出哔哩哔哩登录', tags: ['登录'] },
|
||||
}, async() => {
|
||||
clearCredentials('bili')
|
||||
clearCredentials('bl')
|
||||
return { logged: false }
|
||||
})
|
||||
|
||||
@@ -476,8 +476,8 @@ export const loginRoutes = async(fastify) => {
|
||||
fastify.get('/login/status', {
|
||||
schema: {
|
||||
summary: '查看登录状态',
|
||||
description: 'wy 为实时校验(未登录或 cookie 失效返回 logged: false),kg/tx/bili 为已存凭据(含 VIP 等级与最近更新时间),' +
|
||||
'qs/xm/me/lr/qian/joox/apple/5sing 为已存凭据。',
|
||||
description: 'wy 为实时校验(未登录或 cookie 失效返回 logged: false),kg/tx/bl 为已存凭据(含 VIP 等级与最近更新时间),' +
|
||||
'qs/xm/me/lr/bd/jx/apple/5s 为已存凭据。',
|
||||
tags: ['登录'],
|
||||
},
|
||||
}, async() => {
|
||||
@@ -493,11 +493,11 @@ export const loginRoutes = async(fastify) => {
|
||||
xm: xmStatus(),
|
||||
me: meStatus(),
|
||||
lr: lrAuth.status(),
|
||||
bili: biliAuth.status(),
|
||||
qian: qianStatus(),
|
||||
joox: jooxStatus(),
|
||||
bl: biliAuth.status(),
|
||||
bd: qianStatus(),
|
||||
jx: jooxStatus(),
|
||||
apple: appleStatus(),
|
||||
'5sing': fivesingStatus(),
|
||||
'5s': fivesingStatus(),
|
||||
}
|
||||
})
|
||||
}
|
||||
+8
-8
@@ -513,7 +513,7 @@ export const musicRoutes = async(fastify: any) => {
|
||||
|
||||
const albumSchema = (withPage: boolean) => ({
|
||||
summary: '获取专辑详情与曲目列表',
|
||||
description: '支持 kg/kw/tx/wy/xm/me/qt/lr/migu/qian/joox/apple(见 /sources 的 album 能力位)。' +
|
||||
description: '支持 kg/kw/tx/wy/xm/me/qt/lr/migu/bd/jx/apple(见 /sources 的 album 能力位)。' +
|
||||
'kw 单页固定 1000 条、xm/me 固定 30 条、limit 不生效。',
|
||||
tags: ['歌手专辑'],
|
||||
params: params({
|
||||
@@ -538,7 +538,7 @@ export const musicRoutes = async(fastify: any) => {
|
||||
fastify.get('/album/:source/search/:keyword', {
|
||||
schema: {
|
||||
summary: '搜索专辑',
|
||||
description: '支持 kg/kw/tx/wy/migu/qian/joox/apple(见 /sources 的 albumSearch 能力位)。',
|
||||
description: '支持 kg/kw/tx/wy/migu/bd/jx/apple(见 /sources 的 albumSearch 能力位)。',
|
||||
tags: ['歌手专辑'],
|
||||
params: params({ source: pSource('album.searchAlbum'), keyword: { type: 'string', description: '专辑名关键词', example: '魔杰座' } }),
|
||||
querystring: qs({ page: pPage, limit: pLimit }),
|
||||
@@ -563,8 +563,8 @@ export const musicRoutes = async(fastify: any) => {
|
||||
fastify.get('/playlist/:source/search/:keyword', {
|
||||
schema: {
|
||||
summary: '搜索歌单',
|
||||
description: '支持 kg/kw/tx/wy/migu/qian/joox/bili/5sing/apple(见 /sources 的 playlistSearch 能力位)。' +
|
||||
'部分平台该能力受限(如 qian 歌单搜索接口已下线、bili 需登录),失败时返回 502。',
|
||||
description: '支持 kg/kw/tx/wy/migu/bd/jx/bl/5s/apple(见 /sources 的 playlistSearch 能力位)。' +
|
||||
'部分平台该能力受限(如 bd 歌单搜索接口已下线、bl 需登录),失败时返回 502。',
|
||||
tags: ['歌单'],
|
||||
params: params({ source: pSource('playlist.searchPlaylist'), keyword: { type: 'string', example: '华语' } }),
|
||||
querystring: qs({ page: pPage, limit: pLimit }),
|
||||
@@ -586,7 +586,7 @@ export const musicRoutes = async(fastify: any) => {
|
||||
fastify.get('/playlist/:source/categories', {
|
||||
schema: {
|
||||
summary: '获取歌单分类',
|
||||
description: '支持 kw/kg/tx/wy/migu/qian/joox/bili/5sing/apple(见 /sources 的 playlistCategories 能力位)。',
|
||||
description: '支持 kw/kg/tx/wy/migu/bd/jx/bl/5s/apple(见 /sources 的 playlistCategories 能力位)。',
|
||||
tags: ['歌单'],
|
||||
params: params({ source: pSource('playlist.getCategories') }),
|
||||
response: responses('PlaylistCategoriesResult'),
|
||||
@@ -630,8 +630,8 @@ export const musicRoutes = async(fastify: any) => {
|
||||
|
||||
const playlistSchema = (withPage: boolean) => ({
|
||||
summary: '获取歌单详情与曲目列表',
|
||||
description: 'id 为歌单 id 或链接(部分平台支持链接/裸 id,如 bili 的 season:<id>:<mid>:<bvid>、' +
|
||||
'joox/qian/migu 的网页链接)。列表按 page/limit 切片(聚合接口自身分页的平台由平台决定)。',
|
||||
description: 'id 为歌单 id 或链接(部分平台支持链接/裸 id,如 bl 的 season:<id>:<mid>:<bvid>、' +
|
||||
'jx/bd/migu 的网页链接)。列表按 page/limit 切片(聚合接口自身分页的平台由平台决定)。',
|
||||
tags: ['歌单'],
|
||||
params: params({
|
||||
source: pSource('playlist'),
|
||||
@@ -701,7 +701,7 @@ export const musicRoutes = async(fastify: any) => {
|
||||
schema: {
|
||||
summary: `解析${kind === 'song' ? '歌曲' : kind === 'album' ? '专辑' : '歌单'}链接`,
|
||||
description: '把平台链接(或裸 id)解析成结构化歌曲/曲目数据。支持平台见 /sources 的 parse 能力位;' +
|
||||
'5sing 歌曲/歌单、apple/bili/joox/qian/migu 三类、kw/kg/tx/wy 部分支持。',
|
||||
'5s 歌曲/歌单、apple/bl/jx/bd/migu 三类、kw/kg/tx/wy 部分支持。',
|
||||
tags: ['链接解析'],
|
||||
params: params({ source: pSource('parse.parseSong') }),
|
||||
body: parseBodySchema,
|
||||
|
||||
+2
-2
@@ -48,8 +48,8 @@ const PORT = process.env.PORT || 16688
|
||||
const DOCS_PREFIX = '/docs'
|
||||
const API_TITLE = 'MusicServer 聚合音乐 API'
|
||||
const API_DESCRIPTION = '多平台音乐聚合接口:搜索、播放地址、歌词、封面、榜单、歌单、专辑、歌手、链接解析。' +
|
||||
'支持 kw(酷我)/ kg(酷狗)/ tx(QQ音乐)/ wy(网易云)/ qs(汽水音乐)/ migu(咪咕)/ qian(千千)/ ' +
|
||||
'joox / bili(哔哩哔哩)/ 5sing / apple(Apple Music,仅试听)与有声平台 xm(喜马拉雅)/ me(猫耳FM)/ qt(蜻蜓FM)/ lr(懒人听书)。'
|
||||
'支持 kw(酷我)/ kg(酷狗)/ tx(QQ音乐)/ wy(网易云)/ qs(汽水音乐)/ migu(咪咕)/ bd(千千)/ ' +
|
||||
'jx / bl(哔哩哔哩)/ 5s / apple(Apple Music,仅试听)与有声平台 xm(喜马拉雅)/ me(猫耳FM)/ qt(蜻蜓FM)/ lr(懒人听书)。'
|
||||
|
||||
const pkg = JSON.parse(readFileSync(join(dirname(fileURLToPath(import.meta.url)), '../package.json'), 'utf8'))
|
||||
|
||||
|
||||
Reference in new issue
Block a user