Nexus Prisma 使用教程

最新推荐文章于 2024-09-28 07:46:28 发布

蒋楷迁

最新推荐文章于 2024-09-28 07:46:28 发布

阅读量678

点赞数 20

本文链接：https://blog.csdn.net/gitblog_01002/article/details/142011987

版权

Nexus Prisma 使用教程

nexus-prismaPrisma plugin for Nexus项目地址:https://gitcode.com/gh_mirrors/ne/nexus-prisma

1. 项目介绍

Nexus Prisma 是一个用于 GraphQL 的 Prisma 插件，它允许开发者使用 Prisma 的数据模型定义来生成 GraphQL 类型和解析器。Nexus Prisma 结合了 Nexus 和 Prisma 的优势，使得构建类型安全的 GraphQL API 变得更加简单和高效。

主要功能

类型安全：通过 Prisma 的类型定义自动生成 GraphQL 类型。
代码生成：根据 Prisma 模型自动生成 GraphQL 解析器。
灵活性：支持自定义标量类型和扩展功能。

2. 项目快速启动

安装依赖

首先，确保你已经安装了 Node.js 和 npm。然后，通过以下命令安装 Nexus Prisma 及其依赖：

npm install @nexus/schema @nexus/prisma prisma

初始化 Prisma

在项目根目录下运行以下命令来初始化 Prisma：

npx prisma init

这将生成 prisma/schema.prisma 文件，你可以在其中定义你的数据模型。

定义数据模型

在 prisma/schema.prisma 文件中定义你的数据模型，例如：

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model User {
  id    Int    @id @default(autoincrement())
  name  String
  email String @unique
}

生成 Prisma 客户端

运行以下命令生成 Prisma 客户端：

npx prisma generate

配置 Nexus Prisma

在你的项目中创建一个 schema.ts 文件，并配置 Nexus Prisma：

import { makeSchema } from '@nexus/schema';
import { nexusPrismaPlugin } from '@nexus/prisma';
import { User } from './User';

export const schema = makeSchema({
  types: [User],
  plugins: [nexusPrismaPlugin()],
  outputs: {
    schema: __dirname + '/generated/schema.graphql',
    typegen: __dirname + '/generated/nexus.ts',
  },
});

定义 GraphQL 类型

在 User.ts 文件中定义 GraphQL 类型：

import { objectType } from '@nexus/schema';

export const User = objectType({
  name: 'User',
  definition(t) {
    t.model.id();
    t.model.name();
    t.model.email();
  },
});

启动服务器

最后，启动你的 GraphQL 服务器：

import { ApolloServer } from 'apollo-server';
import { schema } from './schema';

const server = new ApolloServer({ schema });

server.listen().then(({ url }) => {
  console.log(`🚀 Server ready at ${url}`);
});