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

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

1 个答案: