Code Monkey home page Code Monkey logo

graphql-mesh's Introduction

Mesh GIF

npm version CI Discord Chat code style: prettier

https://graphql-mesh.com

Note: this project is early and there will be breaking changes along the way

GraphQL Mesh allows you to use GraphQL query language to access data in remote APIs that don't run GraphQL (and also ones that do run GraphQL). It can be used as a gateway to other services, or run as a local GraphQL schema that aggregates data from remote APIs.

The goal of GraphQL Mesh is to let developers easily access services that are written in other APIs specs (such as gRPC, OpenAPI/Swagger, OData, SOAP/WSDL, Apache Thrift, Mongoose, PostgreSQL, Neo4j, and also GraphQL) with GraphQL queries and mutations.

GraphQL Mesh gives the developer the ability to modify the output schemas, link types across schemas and merge schema types. You can even add custom GraphQL types and resolvers that fit your needs.

It allows developers to control the way they fetch data, and overcome issues related to backend implementation, legacy API services, chosen schema specification and non-typed APIs.

GraphQL Mesh is acting as a proxy to your data, and uses common libraries to wrap your existing API services. You can use this proxy locally in your service or application by running the GraphQL schema locally (with GraphQL execute), or you can deploy this as a gateway layer to your internal service.

Note: GraphQL Mesh doesn’t aim to magically create your utopic public GraphQL schema - it’s just an easy-to-use proxy to your data, and you should consider implementing another layer that exposes your public data the way you need it to be.

How it works?

The way GraphQL Mesh works is:

  1. Collect API schema specifications from services
  2. Create a runtime instance of fully-typed SDK for the services.
  3. Convert API specs to GraphQL schema
  4. Applies custom schema transformations and schema extensions
  5. Creates fully-typed, single schema, GraphQL SDK to fetch data from your services.

Getting Started

Installation

GraphQL Mesh comes in multiple packages, which you should install according to your needs.

To get started with the basics, install the following:

$ yarn add graphql @graphql-mesh/runtime @graphql-mesh/cli

Then, you need to install a Mesh handler, according to your API needs. You can see the list of all available built-in handlers in this README, under the Supported APIs section.

For example, if you wish to use OpenAPI handler, install the handler that matches your needs:

$ yarn add graphql @graphql-mesh/openapi

Then, this handler will be available for you to use in your config file.

Basic Usage

https://graphql-mesh.com/docs/getting-started/basic-example

Supported APIs

https://graphql-mesh.com/docs/handlers/available-handlers

Schema Transformations

https://graphql-mesh.com/docs/getting-started/mesh-transforms

TypeScript Support

https://graphql-mesh.com/docs/recipes/typescript

graphql-mesh's People

Contributors

ardatan avatar ashlovell avatar dependabot[bot] avatar dotansimha avatar isnifer avatar jamesdbruner avatar jycouet avatar kamilkisiela avatar markionium avatar notrab avatar ntziolis avatar pietgk avatar renovate-bot avatar renovate[bot] avatar rufman avatar saerdnaer avatar sofiapoh avatar theguild-bot avatar urigo avatar webdevike avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.