GraphQL：如何定义输入参数/约束

Question

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

我发现这个：https://github.com/confuser/graphql-constraint-directive似乎与我想要的类似，但是我不需要执行/执行，因为django已经这样​​做了。我只想在输入字段上传达这些约束。

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

编辑：也许这不仅是为了记录，而且还告诉前端如何渲染字段和/或能够进行一些前端验证。基本上像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")