图QL Docs 生成器

GraphQL 文档生成器需要一个计数器,并生成该计数器上所有可能的语句(queries,突变和订阅). 这可以作为新到GraphQL的用户的起点.

安装和执行

从命令行执行 :

$ npm install -g @aws-amplify/graphql-docs-generator

$ graphql-docs-generator --schema 'my-graphql-sdl-schema'

$ graphql-docs-generator --schema 'my-graphql-introspection-schema' --maxDepth 2

从节点JS或浏览器环境执行 :

添加对 3.1.0-studio-graphql-4.0 版本 @aws-amplify/graphql-docs-generator 在你身边 package.json 文件,安装和构建.

import { generateGraphQLDocuments } from '@aws-amplify/graphql-docs-generator';

const schema = 'my-graphql-sdl-schema';

// Below are the supported optional customizations and their defaults
const options = {
  maxDepth: 2
};

const generatedResult = generateGraphQLDocuments(schema, options);

// Test logs to demonstrate the output
console.log(generatedResult.queries);
console.log(generatedResult.mutations);
console.log(generatedResult.subscriptions);
console.log(generatedResult.fragments);