57dcc9d329
This command changed in pnpm [6.32.13](https://github.com/pnpm/pnpm/releases/tag/v6.32.13) and [7.1.1](https://github.com/pnpm/pnpm/releases/tag/v7.1.1) so lets update it since its been a few weeks and we can expect pnpm users to update more regularly than npm users. - Fixes https://github.com/vercel/next.js/pull/37240 - Fixes https://github.com/vercel/next.js/pull/37045 - Fixes https://github.com/vercel/next.js/pull/37032 - Fixes https://github.com/vercel/next.js/pull/36602 - Fixes https://github.com/vercel/next.js/pull/36496
61 lines
2.4 KiB
Markdown
61 lines
2.4 KiB
Markdown
# GraphQL Gateway using GraphQL Mesh and Next.js API routes
|
|
|
|
This is a simple set up for Next.js using [GraphQL Mesh](https://www.graphql-mesh.com/docs/introduction) to build a GraphQL Gateway based on a REST API.
|
|
|
|
GraphQL Mesh is a framework that allows to build GraphQL Gateway server, based on one or multiple source APIs (REST, SOAP, gRPC, GraphQL or Databases).
|
|
|
|
```mermaid
|
|
graph TD;
|
|
subgraph AA [" "]
|
|
A[Mobile app];
|
|
B[Web app];
|
|
C[Node.js client];
|
|
end
|
|
subgraph BB [" "]
|
|
E[REST API];
|
|
F[GraphQL API];
|
|
G[SOAP API];
|
|
end
|
|
Z[GraphQL Gateway API on a Next.js API route];
|
|
A & B & C --> Z;
|
|
Z --> E & F & G;
|
|
```
|
|
|
|
Configuring GraphQL Mesh only requires installing the required packages and providing a `.meshrc.yaml` configuration file.
|
|
|
|
This project translate the PetStore REST API (https://petstore.swagger.io/) to a GraphQL API by simply providing the following configuration:
|
|
|
|
_[`.meshrc.yaml`](./.meshrc.yaml)_
|
|
|
|
```yaml
|
|
sources:
|
|
- name: PetStore
|
|
handler:
|
|
newOpenapi:
|
|
baseUrl: https://petstore.swagger.io/v2/
|
|
oasFilePath: https://petstore.swagger.io/v2/swagger.json
|
|
```
|
|
|
|
More information on GraphQL Mesh configuration and concepts [are available in our documentation](https://www.graphql-mesh.com/docs/getting-started/overview).
|
|
|
|
---
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
|
|
|
|
[](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-graphql-gateway&project-name=with-graphql-gateway&repository-name=with-graphql-gateway&env=NEO4J_URI,NEO4J_USER,NEO4J_PASSWORD&envDescription=Required%20to%20connect%20the%20app%20with%20a%20Neo4j%20database&envLink=https://github.com/vercel/next.js/tree/canary/examples/with-graphql-gateway%23step-3-set-up-environment-variables)
|
|
|
|
---
|
|
|
|
## How to use
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example with-graphql-gateway with-graphql-gateway-app
|
|
# or
|
|
yarn create next-app --example with-graphql-gateway with-graphql-gateway-app
|
|
# or
|
|
pnpm create next-app --example with-graphql-gateway with-graphql-gateway-app
|
|
```
|