bgmtv-api
v0.0.2
Published
Bangumi OpenAPI Client
Readme
Bangumi API Client
- 依据此API文档生成的Bangumi API客户端。进行了一些必要的调整和优化。
- 强TypeScript类型支持,唯一有效导出为
createBangumiApiClient函数。 - 缺少token时调用需登录的API不会发送请求。(抛出AuthError)
- 不会尝试读取任何环境变量或配置文件,所有设置需通过参数提供。
- 代理等功能需使用global agent(简单,但不推荐)或自定义
options.fetch的方式实现。
import { createBangumiApiClient, BangumiError } from 'bgmtv-api';
const client = createBangumiApiClient({
// userAgent必填
userAgent: 'xxxxxxxxxxxxxxxxxxxxxxxx',
// accessToken可选,若不提供则为匿名用户
accessToken: 'yyyyyyyyyyyyyyyyyyyyyyyyy',
// fetch: myCustomFetchFunction,
// baseUrl: 'https://api.bgm.tv',
});
try {
const me = await client.getMyself(); // 请求 /v0/me
console.log('我是%s', me.nickname);
} catch (error) {
if (error instanceof BangumiError) {
console.error('返回了错误信息: %s', error.message);
} else {
console.error('未知错误: %s', error);
}
}