npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

graphql-rest-wrapper

v0.1.3

Published

Wraps RestAPI with GraphQL

Downloads

15

Readme

GraphQL - REST Wrapper


Introduction

graphql-rest-wrapper let you use GraphQL on top of your existing REST API very easily. using express-graphql.

See code example

Code Example

The following code will fetch the REST API response, make a GraphQL schema for you, and expose the data from a GraphQL server.

const wrapper = new gqlRestWrapper('http://localhost:9090/restapi', {
    name: 'MyRestAPI',
    generateSchema: true,
    saveSchema: true,
    graphiql: true
})

app.use('/graphql', wrapper.expressMiddleware())

How does it work

  1. When instantiating 'gqlRestWrapper' class, a GraphQL schema will be made for you from the REST API response. (you can provide a schema yourself)
  2. GraphQL wrapper will expose the express middleware function to a chosen route.
  3. When you will send an http request to the route with GraphQL query, GraphQL server will fetch the response from the REST API and send you only the data you asked for.

Installation

Install the npm package

npm i graphql-rest-wrapper

import

var gqlRestWrapper = require(graphql-rest-wrapper)

Instantiate:

/**
 *  GraphQL rest wrapper takes all express-graphql options and some additional options.
 *
 *  Options object:
 *
 *  - express-graphql: (Main ones)
 *  schema: GraphQLSchema    -> You can specify a schema or let gqlRestWrapper to generate one with [generateSchema: true]
 *  graphiql: Boolean        -> Render GraphQL query client
 *
 *  - gqlRestWrapper:
 *  name: String            -> Will name the main query, and file if asked for
 *  generateSchema: Boolean -> Generate schema from the API response
 *  saveSchema: Boolean     -> Save the generated schema to a javascript file
 *
 */

new gqlRestWrapper([ENDPOINT], [OPTIONS])

attach middleware to a route

app.use([ROUTE], wrapper.expressMiddleware())

Sending a query: Simplest way to send a query is using GraphiQL, by setting it to 'true' and just navgating to GraphQL route.

{
  MyRestAPI {
    id
    name
    email
    last_name
    active
    friends
    password {
      hash
      value
    }
  }
}

Or making an HTTP GET/POST request:

fetch("http://localhost:9090/graphql",
    {
        headers: {
            'Accept': 'application/json',
            'Content-Type': 'application/json'
        },
        method: "POST",
        body: "{'query': 'query { MyRestAPI { id, name } }'}"
    })
    .then(function (res) {
        console.log(res);
    })

Schema builder

The GraphQL schema is being built with a modified version of Aweary/json-to-graphql package it will work for simple data structures like I use in the example code:

{
 name : "john_s",
 first_name : "John",
 last_name : "Smith",
 display_name : "Johnny",
 id: 9,
 email : "[email protected]",
 password : {
     value : "my_password",
     hash : "0a0655l2hg32hbr2d23f239"
 },
 friends: ['Mike', 'Jen', 'Chris', 'Tom'],
 active : true
}

But can fall short on more complex data structures, In those cases it needs some help. Just use [saveSchema: true] and tweak it the way you like. then import the file and pass it to the wrapper:

new gqlRestWrapper([ENDPOINT], {
    name: 'MyRestAPI',
    //generateSchema: true,
    //saveSchema: true,
    schema: require(./schema-file)
    graphiql: true
})

Tests

Contributors

License

MIT