如何为现有的graphql模式创建动态文档？

Question

我们希望为现有的graphql-schema创建一个文档文件(然后将其包含到我们的应用程序中)。现在我们导出一个schema.graphql，然后用graphql-markdown创建一个.md文件。

我们想要实现的是，创建的文档可以忽略一些对象或属性，可能类似于弃用字段。最终的文档文件现在应该只包含未标记为要忽略的对象。

我们怎么能这样做呢？

我已经搜索了已经存在的解决方案或文档软件，如Swagger。

Answer 1

您可以使用某个任意字符串为要排除的类型和字段的描述添加前缀，例如@Hidden。然后，只需派生graphql-markdown并修改它，以排除那些对象和字段here

function isIgnored(typeOrField) {
  return typeOrField.description.startsWith('@Hidden')
}

const objects = types.filter(type => {
  return type.kind === 'OBJECT' && type !== query && type !== mutation && !isIgnored(type)
})

和here

const fields = (isInputObject ? type.inputFields : type.fields)
  .filter(field => !isIgnored(field))