Socket
Socket
Sign inDemoInstall

graphqlvisualizer

Package Overview
Dependencies
98
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    graphqlvisualizer

This is a solution that can be used for visualization of an existing graphQL Schema, without the need of having an implemented service, in order to explore the API.


Version published
Weekly downloads
49
Maintainers
1
Created
Weekly downloads
 

Readme

Source

Description:

GraphQlVisualizer is a tool that enables you to visualize existing GraphQL schemas. It lets you explore all aspects of a schema without the need of a functional serverice side. Simply load your schema froma a local file or from a string and get a generated html page, wich will contain graphical representaion of your scehma in a simple, intuitive and interavctive UI.

File will be generated inside src/generated directory, under the name of schemaVisualized.html

Functionalities:

  1. Visualize schema from local file
  2. Visualize schema from string

Installation:

Install using NPM

npm install --save graphqlvisualizer

Usage:

Below is an example of how this package could be used

import GenerateHtmlFromString from "graphqlvisualizer";

var schemaString = `
type User{
    id:ID!
    firstname:String
    lastname:String
    address:Address
}
type Address{
    postalCode:Int
    city:String
}
type Query{
    """
    Returns user with specified id
    """
    user(id: ID): User
    """
    Returns a list of users that have the specified address
    """
    usersOnAddress(address: Address): [User]
}
type Mutation{
    createAddress(postalCode:Int!, city:String): Address
    deleteUser(id:ID):Boolean
}
`;

var schema = GenerateHtmlFromString(schemaString);

Example

This is what generated UI would look like with a list of all defined types: image

Expanded query or mutation would look like image below image

Keywords

FAQs

Last updated on 23 Oct 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc