Neutrinos Peludos Magnéticos
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

apollo-server-micro

2.19.0 • Public • Published

npm version Build Status Join the community on Spectrum Read CHANGELOG

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.

  1. Package installation.
npm install micro apollo-server-micro graphql
  1. 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();
  1. package.json
{
  "main": "index.js",
  "scripts": {
    "start": "micro"
  }
}
  1. 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:

  1. Package installation.
npm install micro micro-cors apollo-server-micro graphql
  1. index.js
const cors = require('micro-cors')(); // highlight-line
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 handler = apolloServer.createHandler(); // highlight-line
module.exports = cors((req, res) => req.method === 'OPTIONS' ? res.end() : handler(req, res)) // highlight-line
  1. package.json
{
  "main": "index.js",
  "scripts": {
    "start": "micro"
  }
}
  1. 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:

  1. Package installation.
npm install micro apollo-server-micro graphql
  1. 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' }); // highlight-line
  1. package.json
{
  "main": "index.js",
  "scripts": {
    "start": "micro"
  }
}
  1. After an npm start, access http://localhost:3000/data 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:

  1. Package installation.
npm install micro microrouter apollo-server-micro graphql
  1. 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!'),
  post(graphqlPath, graphqlHandler),
  get(graphqlPath, graphqlHandler),
);
  1. package.json
{
  "main": "index.js",
  "scripts": {
    "start": "micro"
  }
}
  1. After an npm start, access http://localhost:3000/data in your browser to run queries using graphql-playground, or send GraphQL requests directly to the same URL.

Install

npm i apollo-server-micro

DownloadsWeekly Downloads

21,297

Version

2.19.0

License

MIT

Unpacked Size

42.7 kB

Total Files

26

Last publish

Collaborators

  • avatar