如何在没有webpack的打字稿节点项目中使用.graphql

时间:2018-07-25 18:29:27

标签: typescript graphql

我有一个节点,使用expressGraphql的Express服务器。我试图在.graphql.gql文件中声明graphql的类型定义,因为随着类型的增加,变得很难读取string

这是我所拥有的:

import testQuery from './test.graphql';

import routes from "./routes";

import { buildSchema } from "graphql";

const schema = buildSchema(testQuery);

// Root resolver
const root = {
    message: () => "Hello World!",
};

app.use(
    "/api/graphql",
    expressGraphQL({
        schema,
        graphiql: true,
    })
);

我的graphql文件。 //test.graphql

type Book {
    message: String
}

我收到一个错误,因为打字稿

  

找不到模块'./test.graphql'。

我见过有人这样做:

const { makeExecutableSchema } = require('graphql-tools');

const schemaFile = path.join(__dirname, 'schema.graphql');
const typeDefs = fs.readFileSync(schemaFile, 'utf8');

const schema = makeExecutableSchema({ typeDefs });

这是这样做的方式吗?

所以我需要配置打字稿才能导入并构建模式

3 个答案:

答案 0 :(得分:1)

AFAIK,有两种导入模式文件的方法,一种是通过如上所述直接读取文件,另一种是2)通过将查询包装在导出的变量中。

// bookSchema.ts <- note the file extension is .ts instead of .graphql
export default `
  type Book {
    message: String
  }
`

// anotherSchema.ts <- note the file extension is .ts instead of .graphql
export default `
  type User {
    name: String
  }
`

// main.ts
import bookSchema from 'bookSchema';
import anotherSchema from 'anotherSchema';

const schema = makeExecutableSchema({ typeDefs: [
  bookSchema,
  anotherSchema,
] });

答案 1 :(得分:0)

此答案解决了@leogoesger提出的问题。 它是使用.graphql文件创建模式的模块化方法,无需定义多个makeExecutableSchema调用。

文件夹结构应如下所示:


    src
    - graphql
     - schema.ts
     - bar
      - barResolver.ts
      - schema.graphql
     - foo
      - fooResolver.ts
      - schema.graphql

schema.graphql包含所有类型定义。 “功能”解析器文件包含您的解析器,它是一个包含查询和变异的对象。

schema.ts文件中,您将像这样创建合并的架构:


    import { mergeSchemas, makeExecutableSchema } from "graphql-tools";
    import { readdirSync, lstatSync, existsSync } from "fs";
    import * as path from "path";
    import { importSchema } from 'graphql-import'
    import { GraphQLSchema } from 'graphql';

    const schemas: GraphQLSchema[] = [];

    const isDirectory = dirPath =>  existsSync(dirPath) && lstatSync(dirPath).isDirectory();
    const getDirectories = source =>
      readdirSync(source).map( name => path.join(source, name) ).filter(isDirectory)

    const folders = getDirectories( path.resolve(__dirname, './') )

    folders.forEach(folder => {
        folder = folder.substr( folder.lastIndexOf("\\")+1 )
        const {resolvers} = require(`./${folder}/${folder}Resolver`);
        const typeDefs = importSchema( path.join(__dirname, `./${folder}/schema.graphql`) );
        schemas.push(makeExecutableSchema({resolvers, typeDefs}))
    });

    const mergedSchemas = mergeSchemas({ schemas })

    export default mergedSchemas;

此想法是获取与schema.ts处于同一级别的所有相对目录,然后遍历每个功能名称并导入相应的解析程序和类型定义。接下来,使模式可执行,并将其添加到我们的模式数组中。最后,我们使用mergeSchemas将模式缝合在一起,以从多个API创建单个GraphQL模式。 (有关更多详细信息,请参见https://www.apollographql.com/docs/graphql-tools/schema-stitching。)

然后您可以正常创建服务器

import schema from './graphql/schema';
const server = new GraphQLServer({schema: schema})

答案 2 :(得分:0)

您可以使用https://github.com/ardatan/graphql-import-node来解决此问题,而无需使用webpack。

使用yarn add graphql-import-nodenpm install --save graphql-import-node安装,然后使用graphql-import-node/register钩子(如果使用的是ts-node):

ts-node -r graphql-import-node/register index.ts

或将其导入到文件的顶部,就像这样:

import "graphql-import-node";

我之所以选择后者,是因为我已经将ts-node/registermocha -r一起用于测试。

您可能还需要将"esModuleInterop": true添加到tsconfig.json中的editorOptions中。