Narcissistic Pickle Meister

    @yued/swagger-to-graphql

    1.3.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?

    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 to your local 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
    

    Install

    npm i @yued/swagger-to-graphql

    DownloadsWeekly Downloads

    0

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    240 kB

    Total Files

    25

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar