gqlfetch

README

GQLFetch

GraphQL introspection based schema generator, introspection query document mirrors the graphql-js getIntrospectionQuery document albeit compliant to the June 2018 specification.

Usage

import (
	"github.com/suessflorian/gqlfetch"
)

func main() {
	schema, _ := gqlfetch.BuildClientSchema(ctx, endpoint)
}

Or use as cli tool

Introduced a directory here /gqlfetch which will create a gqlfetch cli tool.

go install github.com/suessflorian/gqlfetch/gqlfetch
# gqlfetch --help
gqlfetch --endpoint "localhost:8080/query" > schema.graphql

If you get an error claiming that gqlfetch cannot be found or is not defined, you may need to add ~/go/bin to your $PATH (MacOS/Linux), or %HOME%\go\bin (Windows).

Roadmap

Hoping to incorporate this into a graphql utility package like gqlparser, enable introspection based type-safe graphql client generation in genqlient and simplify the Service type federated services need to expose to a bramble gateway (improving the schema gathering logic).

Notice

Project not fully mature yet, if you find any issues, please submit an issue.

Documentation

Index

• Constants
• func BuildClientSchema(ctx context.Context, endpoint string, withoutBuiltins bool) (string, error)
• func BuildClientSchemaWithHeaders(ctx context.Context, endpoint string, headers http.Header, ...) (string, error)
• func BuildClientSchemaWithOptions(ctx context.Context, options BuildClientSchemaOptions) (string, error)
• type BuildClientSchemaOptions

Constants

const (
	NON_NULL introspectionTypeKind = "NON_NULL"
	LIST     introspectionTypeKind = "LIST"
	OBJECT   introspectionTypeKind = "OBJECT"
)

Functions

func BuildClientSchema

func BuildClientSchema(ctx context.Context, endpoint string, withoutBuiltins bool) (string, error)

func BuildClientSchemaWithHeaders

func BuildClientSchemaWithHeaders(ctx context.Context, endpoint string, headers http.Header, withoutBuiltins bool) (string, error)

func BuildClientSchemaWithOptions

func BuildClientSchemaWithOptions(ctx context.Context, options BuildClientSchemaOptions) (string, error)

Types

type BuildClientSchemaOptions

type BuildClientSchemaOptions struct {
	Endpoint        string
	Method          string
	Headers         http.Header
	WithoutBuiltins bool
}