jike-sdk Ⓙ Jike SDK

本项目仅供学习交流使用，在使用过程中对你或他人造成的任何损失我们概不负责。

[!CAUTION] 本项目不再积极维护。

Features

• 🌈 可能是东半球最全的第三方 SDK
• ⭐️ 同时支持 Node.js / 浏览器 / Deno / Bun
• 🦾 自带 TypeScript 类型声明

• 用户
  • [x] 获取用户信息
  • [x] 刷新 Access Token
  • [x] 发送登录验证码
  • [x] 短信登录
  • [x] 手机号与密码登录
  • [x] 弹一弹头像
  • [x] 修改用户信息
  • [ ] ~~保存设备 Token~~
• 用户关系
  • [x] 获取关注列表
  • [x] 获取被关注列表
  • [x] 关注
  • [x] 取消关注
  • [x] 是否关注用户
  • [x] 不看 TA 的内容
  • [x] 重新看 TA 的内容
  • [x] 加入黑名单
  • [x] 解除黑名单
• 动态帖子
  • [x] 发送动态
  • [x] 获取动态详情
  • [x] 删除动态
  • [x] 分享动态
  • [x] 点赞
  • [x] 取消点赞
  • [x] 获取点赞用户列表
  • [x] 隐藏动态
  • [x] 动态转为公开
• 动态广场
  • [x] 获取动态推荐
• 评论
  • [x] 获取动态下评论
  • [x] 获取评论
  • [x] 发送评论 （发送子评论）
  • [x] 点赞
  • [x] 取消点赞
  • [x] 删除评论
• 动态
  • [x] 获取用户动态
  • [x] 获取关注动态
  • [x] 置顶动态
  • [x] 取消置顶动态
• 通知
  • [x] 获取通知列表
• 上传
  • [x] 获取上传 token
  • [x] 上传图片
• 日记
  • [x] 获取关注用户日记列表
  • [x] 获取用户的日记详情
• 圈子
  • [x] 获取圈子热门动态
  • [x] 获取圈子动态
  • [x] 搜索圈子

Installation

Node.js

Node.js >= v18.12.0

npm i jike-sdk

ESM 导入

如果使用 ESM 方式导入，需要把 package.json 的 type 设置为 module，或将后缀名改为 .mjs。

// index.mjs

// 使用此版本需 node >= 18 或 自行 ployfill fetch。
import { setApiConfig } from 'jike-sdk'

setApiConfig({
  // ...
})

CJS 导入

const { setApiConfig } = require('jike-sdk')
setApiConfig({
  // ...
})

Bun

Bun >= 0.5.8

bun i jike-sdk

// index.ts
import { setApiConfig } from 'jike-sdk'
setApiConfig({
  // ...
})

Deno

import { setApiConfig } from 'https://cdn.skypack.dev/jike-sdk/index?dts'

浏览器

import { setApiConfig } from 'jike-sdk'

或使用 CDN 的方式加载（与 Deno 一致）

<script type="module">
  import { setApiConfig } from 'https://cdn.skypack.dev/jike-sdk/index'
</script>

由于 CORS 策略的原因，第三方网站无法直接请求外部服务器。但可以使用浏览器扩展的能力请求。

Usage

API Reference

import { ApiClient, api, setAccessToken, setApiConfig } from 'jike-sdk'

// 自行在 GitHub 搜索「jike endpoint」探索配置
const apiConfig = {
  endpointId: 'jike',
  endpointUrl: '<jike-endpoint-url>', // 请自行替换
  bundleId: '<bundle-id>', // 请自行替换
  buildNo: '<build-no>', // 请自行替换
  userAgent: '<jike-sdk-user-agent>', // 请自行替换
  accessToken: '<access-token>', // 请自行替换
}
setApiConfig(apiConfig)

setAccessToken('update-access-token')
api.userRelation.getFollowingList('82D23B32-CF36-4C59-AD6F-D05E3552CBF3', {
  limit: 100,
})

// 或使用 ApiClient
const client = ApiClient(apiConfig)
client.users.profile()

Contributing

see CONTRIBUTING.md

Sponsors

License

AGPL-3.0 License © 2021-PRESENT 三咲智子