跳转到主要内容

GraphQL订阅的Websocket服务器

项目描述

A GraphQL WebSocket服务器和客户端,用于在WebSocket上方便地执行GraphQL查询、突变和订阅(适用于Python 3.6+)。此代码基于subscriptions-transport-ws的当前实现。

入门指南

首先使用pip安装软件包

或者,使用您喜欢的包管理器,如Poetry

使用aiohttp

使用aiohttp的使用很简单

对于其他框架

为其他Web框架添加支持很简单。一个框架必须提供graphql_ws.abc.AbstractConnectionContext的具体实现,然后就可以使用SubscriptionServer了。

用法

使用apollo-link-ws,您可以选择使用Websocket进行查询和突变,而不仅仅是订阅。

与GraphiQL一起使用

demo<./demo>目录中查看GraphiQL的使用示例。由于GraphiQL的javascript客户端实现(GraphiQL-Subscriptions-Fetcher),查询和突变将不会通过websocket处理。

贡献

本项目使用 Poetry,要贡献,只需fork和克隆此仓库,然后使用以下命令设置您的虚拟环境:

如果您尚未安装Poetry,请按照安装文档进行操作。

代码格式化通过 black 完成,并使用 mypy 进行良好的类型检查。

许可协议

本软件包采用MIT许可协议。

由以下提供支持