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

Question

我正在寻找一种在模式中包含额外信息的方法，这样API使用者就知道需要什么了。沿着一根绳子的最大长度来思考。我希望它在模式中，因为它基本上取代了API文档，对吧？在

我发现了这个：https://github.com/confuser/graphql-constraint-directive它看起来与我想要的相似，但是我不需要实现/强制，因为django已经做到了。我只想在输入字段上传达这些约束。在

我对这一切都很陌生，所以有没有可能有一个图形的概念我没有？或者如何在模式中添加这类信息？在

编辑：也许这不仅仅是为了记录文档，还告诉前端如何呈现字段和/或能够进行一些前端验证。基本上就像一个选项请求之类的。在

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")