Giter Club home page Giter Club logo

graphql_2_rest's Introduction

GraphQL to REST

Pub style: very good analysis License: MIT

A simple way to convert GraphQL queries to REST in order to use any HTTP client for performing a request.

Usage

There are 2 main things for working with graphql_2_rest library: GraphQLQueryModel and GraphQLQueryBuilder.

  1. GraphQLQueryModel is responsible for putting arguments in GraphQL query. For example, if you have a query:
const query = '''query {
  user(first_name: %arg, age: %arg) {
    first_name
    last_name
    site {
      site_name
    }
  }
}''';

then you need to create next GraphQLQueryModel:

class UserQueryModel with GraphQLQueryModel {
  const UserQueryModel(
    this.age,
    this.firstName,
  );
  
  final int age;
  final String firstName;
  
  @override
  List<String> get arguments => ['"$firstName"', '$age'];
}
  1. GraphQLQueryBuilder will replace all arguments consistently in the query using GraphQLQueryModel. By default, GraphQLQueryBuilder uses %arg mask for arguments, but it can be changed while creating instance of this class. Finally you can use any HTTP client for performing a request, but the request have to be POST:
final dio = Dio(BaseOptions(baseUrl: 'https://endpoint/'));
const queryBuilder = GraphQLQueryBuilder();
dio.post<dynamic>(
  'graphql/',
  data: queryBuilder.build(
    query, 
    UserQueryModel('John', 27),
  ),
);

graphql_2_rest's People

Contributors

dimakutko 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.