Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

apollo-server-azure-functions

2.11.0 • Public • Published

This is the Azure functions integration of GraphQL Server. Apollo Server is a community-maintained open-source GraphQL server that works with many Node.js HTTP server frameworks. Read the docs. Read the CHANGELOG.

npm install apollo-server-azure-functions

Writing azure function

Azure functions currently support two runtime versions. This package assumes that function is running under runtime 2.0.

Azure functions typically consist of at least 2 files - index.js (function handler definition) and function.json (function settings and bindings). For more information about azure functions development model in general, refer to official Azure functions docs.

Example index.js:

const { gql, ApolloServer } = require("apollo-server-azure-functions");
 
// Construct a schema, using GraphQL schema language
const typeDefs = gql`
  type Query {
    hello: String
  }
`;
 
// A map of functions which return data for the schema.
const resolvers = {
  Query: {
    hello: () => "world"
  }
};
 
const server = new ApolloServer({ typeDefs, resolvers });
 
module.exports = server.createHandler();

Example function.json:

{
  "disabled": false,
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    }
  ]
}

It is important to set output binding name to '$return' for apollo-server-azure-function to work correctly.

Modifying the Azure Function Response (Enable CORS)

To enable CORS the response HTTP headers need to be modified. To accomplish this use the cors option.

const { ApolloServer, gql } = require('apollo-server-azure-functions');
 
// Construct a schema, using GraphQL schema language
const typeDefs = gql`
  type Query {
    hello: String
  }
`;
 
// Provide resolver functions for your schema fields
const resolvers = {
  Query: {
    hello: () => 'Hello world!',
  },
};
 
const server = new ApolloServer({
  typeDefs,
  resolvers,
});
 
module.exports = server.createHandler({
  cors: {
    origin: '*',
    credentials: true,
  },
});

To enable CORS response for requests with credentials (cookies, http authentication) the allow origin header must equal the request origin and the allow credential header must be set to true.

const { ApolloServer, gql } = require('apollo-server-azure-functions');
 
// Construct a schema, using GraphQL schema language
const typeDefs = gql`
  type Query {
    hello: String
  }
`;
 
// Provide resolver functions for your schema fields
const resolvers = {
  Query: {
    hello: () => 'Hello world!',
  },
};
 
const server = new ApolloServer({
  typeDefs,
  resolvers,
});
 
module.exports = server.createHandler({
  cors: {
    origin: true,
    credentials: true,
  },
});

Cors Options

The options correspond to the express cors configuration with the following fields(all are optional):

  • origin: boolean | string | string[]
  • methods: string | string[]
  • allowedHeaders: string | string[]
  • exposedHeaders: string | string[]
  • credentials: boolean
  • maxAge: number

Principles

GraphQL Server is built with the following principles in mind:

  • By the community, for the community: GraphQL Server's development is driven by the needs of developers
  • Simplicity: by keeping things simple, GraphQL Server is easier to use, easier to contribute to, and more secure
  • Performance: GraphQL Server is well-tested and production-ready - no modifications needed

Anyone is welcome to contribute to GraphQL Server, just read CONTRIBUTING.md, take a look at the roadmap and make your first PR!

Install

npm i apollo-server-azure-functions

DownloadsWeekly Downloads

2,293

Version

2.11.0

License

MIT

Unpacked Size

36.1 kB

Total Files

20

Last publish

Collaborators

  • avatar