跳转到内容

GraphQL API

录播姬提供了 GraphQL API,路径为 /graphql。为了方便开发和测试,录播姬还提供了 GraphiQL 之类的可视化工具,可以查看录播姬提供的 query 和 mutation。

更多关于 GraphQL 本身的教程和文档请参考 GraphQL 官方文档或它的中文翻译

GraphQL Schema 可以通过 introspection 获取,请使用 GraphQL Playground 等工具获取。

请求示例:

POST /graphql HTTP/1.1
Accept: application/json
Content-Type: application/json
{"query":"query ($id: Int) { room(roomId: $id) { name shortId roomConfig { roomId } }}","variables":{"id":3}}

响应示例:

{
"data": {
"room": {
"name": "3号直播间",
"shortId": 3,
"roomConfig": {
"roomId": 23058
}
}
}
}