Nevertheless Published Mine

    graphql-faker-programmatic

    1.2.7 • Public • Published

    Just a programmatic version of https://github.com/APIs-guru/graphql-faker to use in create-native-graphql-app.

    GraphQL Faker logo

    GraphQL Faker

    npm David David npm

    Mock your future API or extend the existing API with realistic data from faker.js. No coding required. All you need is to write GraphQL IDL. Don't worry, we will provide you with examples in our IDL editor.

    In the GIF bellow we add fields to types inside real GitHub API and you can make queries from GraphiQL, Apollo, Relay, etc. and receive real data mixed with mock data. demo-gif

    How does it work?

    We use @fake directive to let you specify how to fake data. And if 60+ fakers is not enough for you, just use @examples directive to provide examples. Just add a directive to any field or custom scalar definition:

    type Person {
      name: String @fake(type: firstName)
      gender: String @examples(values: ["male", "female"])
    }
    

    No need to remember or read any docs. Autocompletion is included!

    Features

    • 60+ different types of faked data e.g. streetAddress, firstName, lastName, imageUrl, lorem, semver
    • Comes with multiple locales supported
    • Runs as a local server (can be called from browser, cURL, your app, etc.)
    • Interactive editor with autocompletion for directives with GraphiQL embeded
    • ✨ Support for proxying existing GraphQL API and extending it with faked data Extend mode diagram

    Install

    npm install -g graphql-faker
    

    or

    yarn global add graphql-faker
    

    TL;DR

    Mock GraphQL API based on example IDL and open interactive editor:

    graphql-faker --open
    

    Note: You can specify non-existing IDL file names - Faker will use example IDL which you can edit in interactive editor.

    Extend real data from SWAPI with faked data based on extension IDL:

    graphql-faker ./ext-swapi.grqphql --extend http://swapi.apis.guru
    

    Extend real data from GitHub API with faked data based on extension IDL (you can get token here):

    graphql-faker ./ext-gh.graphql --extend https://api.github.com/graphql \
    --header "Authorization: bearer <TOKEN>"
    

    Usage

    graphql-faker [options] [IDL file]
    

    [IDL file] - path to file with IDL. If this argument is omited Faker uses default file name.

    Options

    • -p, --port HTTP Port [default: 9002]
    • -e, --extend URL to existing GraphQL server to extend
    • -o, --open Open page with IDL editor and GraphiQL in browser
    • -H, --header Specify headers to the proxied server in cURL format, e.g.: Authorization: bearer XXXXXXXXX
    • --co, --cors-origin CORS: Specify the origin for the Access-Control-Allow-Origin header
    • -h, --help Show help

    Development

    npm install
    npm run build:all
    npm run start

    Keywords

    none

    Install

    npm i graphql-faker-programmatic

    DownloadsWeekly Downloads

    13

    Version

    1.2.7

    License

    MIT

    Last publish

    Collaborators

    • luandro