如何将 GraphQL 模式转换为 JSON 并最好地转换为 GraphQL 模式？

Question

我发现这给了我GraphQLSchema，我希望我可以将其转换为 JSON。如何？

// @flow

import path from 'path';
import fs from 'fs';
import {
  buildSchema,
} from 'graphql';

const main = () => {
  const schemaPath = path.resolve(__dirname, '../schema.graphql');

  console.log(buildSchema(fs.readFileSync(schemaPath, 'UTF8')));
};

main();

以及如何做相反的事情——如何将 GraphQL 模式的 JSON 表示转换为 GraphQL 标记？

我发现的一种方法是：

import {
  printSchema,
  buildSchema,
  buildClientSchema,
  printIntrospectionSchema,
  introspectionFromSchema,
} from 'graphql';

printSchema(buildClientSchema(introspectionFromSchema(buildSchema(fs.readFileSync('./schema.graphql', 'UTF8')))))

但是，这会丢失大量数据，例如

type Venue implements Node @preLoad {
  # test
  id: ID!
  fuid: String!
  url: String!
  name: String!
  cinema: Cinema!
  futureEventCount: Int!
  globalCinemaVenue: GlobalCinemaVenue
}

变成：

type Venue implements Node {
  id: ID!
  fuid: String!
  url: String!
  name: String!
  cinema: Cinema!
  futureEventCount: Int!
  globalCinemaVenue: GlobalCinemaVenue
}

Answer 1

您在这里不需要外部库，您拥有所需的一切graphql-js：

import { introspectionFromSchema } from "graphql"
import { GraphQLFileLoader } from "@graphql-tools/graphql-file-loader"
import { loadSchema } from "@graphql-tools/load"

// it can be any source you want here
const schema = loadSchema("./schema.graphql", {
  loaders: [new GraphQLFileLoader()],
})  
const introspection = introspectionFromSchema(schema)

// Tada, you have your introspection

Answer 2

您可以使用以下软件包，我相信在撰写本文时该软件包不可用： https: //www.npmjs.com/package/graphql-2-json-schema

import {
    graphqlSync,
    getIntrospectionQuery,
    IntrospectionQuery
} from 'graphql';

import { fromIntrospectionQuery } from 'graphql-2-json-schema';

const options = {
  ignoreInternals: true,
  nullableArrayItems: true
}

const introspection = graphqlSync(schema, getIntrospectionQuery()).data as IntrospectionQuery;

const jsonSchema = fromIntrospectionQuery(introspection, options);