如何运作
- 写入类型脚本类型
src/gqlkit/schema/• 成为图QL类型 - 使用
defineQuery, (中文(简体) ),defineMutation, (中文(简体) ),defineField成为图QL 解析器 - 运行
gqlkit gen− 产出typeDefs财务报告和审定财务报表resolvers改为src/gqlkit/__generated__/
要点
- 先执行 - 写类型和解析器, 生成计划当准备好。 没有编辑-再生成-执行循环.
- 只是类型和功能 - 有薄API的普通类型脚本。 没有复杂的通则,没有装饰.
- 类型安全 - TypeScript类型成为GraphQL类型。 在编译时检查解析器签名 .
开始
1. 安装依赖关系
# Runtime dependencies
npm install @gqlkit-ts/runtime graphql @graphql-tools/schema
# Development dependency
npm install -D @gqlkit-ts/cli
2. 创建类型和解决方案
// src/gqlkit/gqlkit.ts
import { createGqlkitApis } from "@gqlkit-ts/runtime";
import { Context } from "./context.js";
export const { defineField, defineQuery, defineMutation } = createGqlkitApis<Context>();
// src/gqlkit/schema/task.ts
import type { IDString, NoArgs } from "@gqlkit-ts/runtime";
import { defineQuery, defineMutation } from "../gqlkit.js";
export type Task = {
id: IDString;
title: string;
completed: boolean;
};
const tasksData: Task[] = [];
// Query
export const tasks = defineQuery<NoArgs, Task[]>(() => tasksData);
// Mutation
export const createTask = defineMutation<{ input: { title: string } }, Task>(
(_root, { input }) => {
const task: Task = {
id: crypto.randomUUID(),
title: input.title,
completed: false,
};
tasksData.push(task);
return task;
}
);
3. 产生计划和解决者
gqlkit gen
此生成 :
src/gqlkit/__generated__/typeDefs.ts- 图QL计划ASTsrc/gqlkit/__generated__/resolvers.ts- 解析器地图src/gqlkit/__generated__/schema.graphql- SDL文件
4. 创建可执行计划
// src/schema.ts
import { makeExecutableSchema } from "@graphql-tools/schema";
import { typeDefs } from "./gqlkit/__generated__/typeDefs.js";
import { resolvers } from "./gqlkit/__generated__/resolvers.js";
export const schema = makeExecutableSchema({ typeDefs, resolvers });
5. 启动 GraphQL 服务器( 如瑜伽)
npm install graphql-yoga
// src/server.ts
import { createServer } from "node:http";
import { createYoga } from "graphql-yoga";
import { schema } from "./schema.js";
const yoga = createYoga({ schema });
const server = createServer(yoga);
server.listen(4000, () => {
console.log("Server running at http://localhost:4000/graphql");
});
运行服务器并打开 http://localhost: 4000/graphql 访问 GraphiQL :
mutation {
createTask(input: { title: "Learn gqlkit" }) {
id
title
completed
}
}
query {
tasks {
id
title
completed
}
}
文档
详细用途、特征和API参考文献访问文件网站: