apollo-server

mirror of https://github.com/vale981/apollo-server synced 2025-03-05 09:41:40 -05:00

History

Jesse Rosenberger 034383f491 Consistently use `parent`, rather than `root`, as first resolver argument. In an effort to maintain consistency and semantically correct meaning, this changes (only in documentation and internal Apollo Server tests) the name of the first argument in resolver signatures to use `parent` rather than `root`. While `root` certainly makes sense when the resolver is belonging to the root `Query` or `Mutation` type, once nested field resolvers begin getting called, the more semantically correct term would seem to be `parent`. Since `parent` still makes sense at the root level, and since resolvers frequently get copied and pasted into more deeply-nested positions, putting this pattern in place for apps which are just beginning might just help someone more clearly understand the relationship in the future — without incorrectly thinking that a nested resolver is accessing the root of the graph, rather than the parent.		2018-11-16 20:37:26 +02:00
..
src	(compat) Avoid TypeScript 3.x features to maintain backwards compatibility.	2018-11-05 05:24:32 -08:00
.npmignore	Apollo Server 2 Micro integration (#1279 )	2018-07-05 11:40:15 -07:00
jest.config.js	Replace `{}` with `Object.create(null)` in `jest.config.js`	2018-10-12 13:00:13 +02:00
package.json	Publish	2018-11-13 15:58:57 +02:00
README.md	Consistently use `parent`, rather than `root`, as first resolver argument.	2018-11-16 20:37:26 +02:00
tsconfig.json	Remove test dependencies from non-test `tsconfig.json` files	2018-10-11 12:58:03 +02:00

README.md

title	description
Micro	Setting up Apollo Server with Micro

This is the Micro integration for the Apollo community GraphQL Server. Read the docs. Read the CHANGELOG.

Basic GraphQL Microservice

This example demonstrates how to setup a simple microservice, using Micro, that handles incoming GraphQL requests via the default /graphql endpoint.

Package installation.

npm install --save micro apollo-server-micro@rc graphql

index.js

const { ApolloServer, gql } = require('apollo-server-micro');

const typeDefs = gql`
  type Query {
    sayHello: String
  }
`;

const resolvers = {
  Query: {
    sayHello(parent, args, context) {
      return 'Hello World!';
    },
  },
};

const apolloServer = new ApolloServer({ typeDefs, resolvers });
module.exports = apolloServer.createHandler();

package.json

{
  "main": "index.js",
  "scripts": {
    "start": "micro"
  }
}

After an npm start, access http://localhost:3000/graphql in your browser to run queries using graphql-playground, or send GraphQL requests directly to the same URL.

CORS Example

This example demonstrates how to setup a simple Micro + CORS + GraphQL microservice, using micro-cors:

Package installation.

npm install --save micro micro-cors apollo-server-micro@rc graphql

index.js

const cors = require('micro-cors')();
const { ApolloServer, gql } = require('apollo-server-micro');

const typeDefs = gql`
  type Query {
    sayHello: String
  }
`;

const resolvers = {
  Query: {
    sayHello(parent, args, context) {
      return 'Hello World!';
    },
  },
};

const apolloServer = new ApolloServer({ typeDefs, resolvers });
module.exports = cors(apolloServer.createHandler());

package.json

{
  "main": "index.js",
  "scripts": {
    "start": "micro"
  }
}

After an npm start, access http://localhost:3000/graphql in your browser to run queries using graphql-playground, or send GraphQL requests directly to the same URL.

Custom GraphQL Path Example

This example shows how to setup a simple Micro + GraphQL microservice, that uses a custom GraphQL endpoint path:

Package installation.

npm install --save micro apollo-server-micro@rc graphql

index.js

const { ApolloServer, gql } = require('apollo-server-micro');

const typeDefs = gql`
  type Query {
    sayHello: String
  }
`;

const resolvers = {
  Query: {
    sayHello(parent, args, context) {
      return 'Hello World!';
    },
  },
};

const apolloServer = new ApolloServer({ typeDefs, resolvers });
module.exports = apolloServer.createHandler({ path: '/data' });

package.json

{
  "main": "index.js",
  "scripts": {
    "start": "micro"
  }
}

After an npm start, access http://localhost:3000/graphql in your browser to run queries using graphql-playground, or send GraphQL requests directly to the same URL.

Fully Custom Routing Example

This example demonstrates how to setup a simple Micro + GraphQL microservice, that uses micro-router for fully custom routing:

Package installation.

npm install --save micro microrouter apollo-server-micro@rc graphql

index.js

const { router, get, post, options } = require('microrouter');
const { ApolloServer, gql } = require('apollo-server-micro');

const typeDefs = gql`
  type Query {
    sayHello: String
  }
`;

const resolvers = {
  Query: {
    sayHello(parent, args, context) {
      return 'Hello World!';
    },
  },
};

const apolloServer = new ApolloServer({ typeDefs, resolvers });
const graphqlPath = '/data';
const graphqlHandler = apolloServer.createHandler({ path: graphqlPath });
module.exports = router(
  get('/', (req, res) => 'Welcome!'),
  options(graphqlPath, graphqlHandler),
  post(graphqlPath, graphqlHandler),
  get(graphqlPath, graphqlHandler),
);

package.json

{
  "main": "index.js",
  "scripts": {
    "start": "micro"
  }
}

After an npm start, access http://localhost:3000/graphql in your browser to run queries using graphql-playground, or send GraphQL requests directly to the same URL.