altair-koa-middleware.md

parent
Integrations

altair-koa-middleware

npm {: .label .label-red } Koa {: .label .label-purple }

You can use altair with a koa server using altair-koa-middleware.

This is an koa middleware for mounting an instance of altair GraphQL client.

Installation

This is a node module and can be installed using npm:

npm install --save altair-koa-middleware

Alternatively, if you are using yarn:

yarn add altair-koa-middleware

Usage

import Koa from 'koa';
import KoaRouter from 'koa-router';
import { createRouteExplorer } from 'altair-koa-middleware';
const app = new Koa();
const router = new KoaRouter();

createRouteExplorer({
  url: '/altair',
  router,
  opts: {
    endpoint: '/graphql',
    subscriptionsEndpoint: `ws://localhost:4000/subscriptions`,
    initialQuery: `{ getData { id name surname } }`,
  },
});

app
  .use(router.routes())
  .use(router.allowedMethods());

app.listen(3500);

// ... the rest of your code ...

An instance of Altair GraphQL Client would be available at /altair of your server.