Miss any of our Open RFC calls?Watch the recordings here! »

@leoendless/swagger-to-graphql

1.8.0 • Public • Published

Swagger2GraphQL

Swagger2GraphQL converts your existing Swagger schema to GraphQL types where resolvers perform HTTP calls to certain real endpoints. It allows you to move your API to GraphQL with nearly zero effort and maintain both REST and GraphQL APIs.

Why?

Looking for contributors!

Usage

Basic server

const express = require('express');
const app = express();
const graphqlHTTP = require('express-graphql');
const graphQLSchema = require('swagger-to-graphql');
 
const proxyUrl = 'http://petstore.swagger.io/v2';
const pathToSwaggerSchema = './petstore.json';
const customHeaders = {
  // Authorization: 'Basic YWRkOmJhc2ljQXV0aA=='
}
 
graphQLSchema(pathToSwaggerSchema, proxyUrl, customHeaders).then(schema => {
  app.use('/graphql', graphqlHTTP(() => {
    return {
      schema,
      graphiql: true
    };
  }));
 
  app.listen(3009, 'localhost', () => {
    console.info('http://localhost:3009/graphql');
  });
}).catch(e => {
  console.log(e);
});

Constructor (graphQLSchema) arguments:

  • pathToSwaggerSchema (string) is a path or URL to your swagger schema file. required
  • proxyUrl (string) base URL which will be used to hit your HTTP API. Can be taken either from Swagger schema baseUrl configuration or from this parameter.
  • customHeaders (object) key value object of custom headers, which should be included to the HTTP request. Can be used for example for authorization (look at the example above)

CLI usage

You can use the library just to convert schemas without actually running server

npm i -g swagger-to-graphql
swagger-to-graphql --swagger=/path/to/swagger_schema.json > ./types.graphql

Video from O.J. Sousa Rodrigues at Vienna.JS

Build Status

Install

npm i @leoendless/swagger-to-graphql

DownloadsWeekly Downloads

3

Version

1.8.0

License

MIT

Unpacked Size

29.9 kB

Total Files

8

Last publish

Collaborators

  • avatar