如何在graphql中获取响应中的所有字段而不在查询中传递任何字段名称

Posted 2023-03-08

【中文标题】如何在graphql中获取响应中的所有字段而不在查询中传递任何字段名称

【英文标题】：How to get all fields in a response in graphql without passing any field names in a query

【发布时间】：2021-05-14 21:48:54

【问题描述】：

我正在使用 golang 构建一个 graphql 界面。我正在使用 gqlgen 包来实现它。 在这里，我需要在查询中传递所有字段名称以得到响应，但问题是我的数据很大，它有 30 多个字段，很难在查询中传递所有字段。 这是我的查询

Modelid, name, email, mobile,...............

像这样我需要传递所有字段名称。

相反，我正在寻找一个将返回所有字段而不传递任何字段的结果。我的意思是，如果不传递任何字段名称，它应该全部返回。

例如

Model

【参考方案1】：

首先，您确实应该列出查询中的所有字段。这就是graphql的本质。它很冗长，但大多数客户端库无论如何都会从您的数据结构中获取字段，所以它并不是那么糟糕。

所以我建议手动列出所有字段！

使用标量（必须在 v0.11.3 或更低版本上，请参阅https://github.com/99designs/gqlgen/issues/1293）

但如果你坚持，如果有意愿，就有办法。您可以使用 GraphQL 的标量类型并制作自己的。请参阅此文档了解如何使用 gqlgen 制作它们：https://gqlgen.com/reference/scalars/

在您的架构中，您可以创建一个JSON 标量：

scalar JSON

type Query 
  random: JSON!

为此制作一个模型

// in your own models.go
// You can really play with this to make it better, easier to use
type JSONScalar json.RawMessage

// UnmarshalGQL implements the graphql.Unmarshaler interface
func (y *JSONScalar) UnmarshalGQL(v interface) error 
    data, ok := v.(string)
    if !ok 
        return fmt.Errorf("Scalar must be a string")
    

    *y = []byte(data)
    return nil


// MarshalGQL implements the graphql.Marshaler interface
func (y JSONScalar) MarshalGQL(w io.Writer) 
    _, _ = w.Write(y)

然后将标量链接到gql.yml 中的自定义类型

models:
  JSON:
    model: github.com/your-project/path/graph/model.JSONScalar

当您运行生成（使用 gqlgen v0.11.3 或更低版本，gqlgen version）时，您的解析器现在将使用您创建的自定义类型。而且很容易使用：

func (r *queryResolver) random(ctx context.Context) (model.JSONScalar, error) 
    // something is the data structure you want to return as json
    something := struct 
        Value string
    
        Value: "Hello World",
    

    d, _ := json.Marshal(something)
    return model1.JSONScalar(d), nil

查询结果

// Query

  random


// Response

  "random" : 
    "Value": "Hello World!"