https://github.com/zaiste/next-graphql-server

next-graphql-server is a library for building production-grade GraphQL servers using Next.js with API Routes
https://github.com/zaiste/next-graphql-server

graphql graphql-js graphql-server graphql-tools nextjs nextjs-plugin nextjs-serverless nextjs-typescript typescript

Last synced: 3 months ago
JSON representation

next-graphql-server is a library for building production-grade GraphQL servers using Next.js with API Routes

• Host: GitHub
• URL: https://github.com/zaiste/next-graphql-server
• Owner: zaiste
• License: apache-2.0
• Created: 2022-03-05T01:52:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-25T03:44:02.000Z (about 1 year ago)
• Last Synced: 2024-09-28T21:42:30.832Z (3 months ago)
• Topics: graphql, graphql-js, graphql-server, graphql-tools, nextjs, nextjs-plugin, nextjs-serverless, nextjs-typescript, typescript
• Language: TypeScript
• Homepage: https://demo-graphql.vercel.app/
• Size: 138 KB
• Stars: 88
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# next-graphql-server

`next-graphql-server` is an easy to use Next.js library for creating performant GraphQL endpoints on top of [Next.js API Routes](https://nextjs.org/docs/api-routes/introduction).

Start building GraphQL servers with Next.js.

## Features

* built using [Envelop](https://www.envelop.dev) and [Helix](https://graphql-helix.vercel.app) - stackable and easy to extend architecture

* supports Vercel Edge functions 

## Getting Started 

Create a Next.js project:

```

pnpm create next-app --typescript

```

Add `next-graphql-server` as a dependency to your Next.js project:

```

pnpm add next-graphql-server

```

**Note**: `pnpm` is preferred, but you can also use `npm` or `yarn`

```

npm install next-graphql-server

```

```

yarn add next-graphql-server

```

## Usage

`next-graphql-server` uses [Next.js API Routes](https://nextjs.org/docs/api-routes/introduction). Create the `pages/api/graphql.ts` with the following content:

**Note**: The file in `pages/api` must be named `graphql`

### with `graphql`

Add `graphql` 

```

pnpm add graphql

```

```ts

import { createGraphQLHandler } from "next-graphql-server";

import {

  GraphQLObjectType,

  GraphQLSchema,

  GraphQLString,

} from "graphql";

const schema = new GraphQLSchema({

  query: new GraphQLObjectType({

    name: "Query",

    fields: () => ({

      hello: {

        type: GraphQLString,

        resolve: () => "world",

      },

    }),

  }),

});

const handler = createGraphQLHandler(schema);

export default handler;

```

### with `@graphql-tools` 

Add `@graphql-tools/schema`

```

pnpm add @graphql-tools/schema

```

In `pages/api/graphql.ts` define your handler as shown below:

```ts

import { createGraphQLHandler } from "next-graphql-server";

import { makeExecutableSchema } from "@graphql-tools/schema";

export const schema = makeExecutableSchema({

  typeDefs: /* GraphQL */ `

    type Query {

      hello: String!

    }

  `,

  resolvers: {

    Query: {

      hello: () => 'World',

    },

  },

});

const handler = createGraphQLHandler(schema);

export default handler;

```

### with Pothos