一个普通的REST API可能允许你以不同的格式请求相同的数据,使用不同的Accept
头,例如application/json
、text/html
或text/csv
的响应。
然而,如果你使用GraphQL,JSON似乎是唯一可接受的返回内容类型。但是,我需要我的API能够返回CSV数据,以供不太复杂的客户机使用,这些客户机不理解JSON。
如果给定一个Accept: text/csv
头,GraphQL端点返回CSV数据是否有意义?如果没有,有没有更好的方法来做到这一点?
这更像是一个概念性的问题,但我专门使用Graphene来实现我的API。它是否提供了任何处理自定义内容类型的机制?
3条答案
按热度按时间cs7cruho1#
是的,你可以,但它不是内置的,你必须覆盖一些东西。这更像是一个工作。
执行以下步骤,您将获得csv输出:
1.将
csv = graphene.String()
添加到您的查询中,并将其解析为您想要的任何内容。1.创建一个继承
GraphQLView
的新类1.重写
dispatch
函数,使其看起来像这样:1.导入所有必需的模块
1.用新的视图类替换
urls.py
文件中的默认GraphQLView
。现在,如果你在GraphQL查询中包含“csv”,它将返回原始csv数据,然后你可以将数据保存到前端的csv文件中。示例查询如下所示:
请记住,这是一种以csv格式获取原始数据的方法,您必须保存它。你可以在JavaScript中使用以下代码来实现:
这种方法会展平JSON数据,因此不会丢失任何数据。
iqih9akk2#
我必须实现将列表查询导出到CSV文件的功能。下面是我如何实现扩展@Sina方法的。
我的graphql查询检索用户列表(限制分页)是
通过从GraphQLView继承来创建CustomGraphQLView视图,并覆盖调度函数,以查看查询是否具有csv,并确保更新指向此自定义GraphQLView的graphql url。
操作名称是调用所用的查询名称。在前面的示例中,它是userCsv,并且它是必需的,因为作为响应的最终结果带有此键。获得的响应是django http响应对象。使用上面的操作名称,我们检查在查询中是否存在CSV,如果不存在,则按原样返回响应,但是如果存在CSV,则提取查询结果,并且制作CSV文件,并且存储它,并且在响应中附加它的路径。
下面是查询的graphql模式
下面是示例响应
PS:上面生成的数据来自faker库,我使用的是graphene-django-extras,json_normalize来自pandas。CSV文件可以从响应中获得的路径下载。
jdgnovmf3#
GraphQL依赖于(并且因为)响应嵌套数据而发光。据我所知,CSV只能显示平面键值对。这使得CSV并不真正适合GraphQL响应。
我认为实现你想要做的事情的最干净的方法是在你的客户端前面放一个GraphQL客户端:
这里的好处是,您的适配器只需要能够将它指定的查询转换为CSV。
显然,你可能并不总是能够做到这一点(但你如何让他们发送GraphQL查询)。或者,您可以构建一个将JSON转换为CSV的中间件。但是你必须处理整个GraphQL规范。祝你好运翻译这个答案:
因此,如果你不能通过HTTP传输CSV,那么GraphQL就是一个错误的选择,因为它不是为这个而构建的。如果你不允许那些很难转换成CSV的GraphQL特性,你就不再有GraphQL了,所以叫它GraphQL也没有意义。