GraphQL：如何定义输入 parameters/constraints

Question

我正在寻找一种在架构中包含额外信息的方法，以便 API 消费者知道预期的内容。沿着字符串或其他东西的最大长度思考。我希望它在架构中，因为它基本上取代了 API 文档，对吧？

我发现了这个：https://github.com/confuser/graphql-constraint-directive 这似乎与我想要的相似，但是我不需要 implementation/enforcement 因为 django 已经这样做了。我只想传达这些对输入字段的限制。

我对这一切都很陌生，所以我可能缺少 graphql 的概念吗？或者如何在架构中添加此类信息？

编辑：也许这不仅是为了记录，也是为了告诉前端如何呈现字段 and/or 能够进行一些前端验证。基本上就像一个 OPTIONS 请求什么的。

Answer 1

如果您要做的只是记录有关特定字段或类型的内容，您可以在任一字段上设置 description。添加描述似乎并没有在官方文档中概述，但是有 this issue 。

class MyType(graphene.ObjectType):
    class Meta:
        description = "Some description for MyType"

    my_field = graphene.String(description="Some description for myField")

GraphQL：如何定义输入 parameters/constraints

GraphQL: How do I define input parameters/constraints

python

django

input

graphql

graphene-python