title: Adonis description: Setting up Apollo Server with Adonis
This is the Adonis Framework integration of Apollo Server. Apollo Server is a community-maintained open-source Apollo Server that works with all Node.js HTTP server frameworks: Express, Connect, Hapi, Koa, Adonis Framework, and Restify. Read the docs. Read the CHANGELOG.
npm install apollo-server-adonis
Usage
// start/routes.jsconst graphqlAdonis = ;// or using es6 modules; const Route = ; Route;Route;
GraphiQL
You can also use apollo-server-adonis
for hosting the GraphiQL in-browser IDE. Note the difference between graphqlAdonis
and graphiqlAdonis
.
// start/routes.jsconst graphiqlAdonis = ;// or using es6 modules; const Route = ; // Setup the /graphiql route to show the GraphiQL UIRoute;
In case your GraphQL endpoint is protected via authentication, or if you need to pass other custom headers in the request that GraphiQL makes, you can use the passHeader
option – a string that will be added to the request header object.
For example:
// start/routes.jsconst graphiqlAdonis = ;// or using es6 modules; const Route = ; Route;
Principles
Apollo Server is built with the following principles in mind:
- By the community, for the community: Apollo Server's development is driven by the needs of developers
- Simplicity: by keeping things simple, Apollo Server is easier to use, easier to contribute to, and more secure
- Performance: Apollo Server is well-tested and production-ready - no modifications needed
Anyone is welcome to contribute to Apollo Server, just read CONTRIBUTING.md, take a look at the roadmap and make your first PR!