graphiql

README

Golang GraphiQL

An utility wrote on Go for using GraphiQL without need to use NPM.

Try the live demo.

Getting started

To install the library, run:

go get -u github.com/ubeep/graphiql

Use GraphiQL on your own server

If you've a GraphQL server on GO and you want to include the GraphiQL on it, it's as simple as this:

package main

import(
	"net/http"
	"github.com/ubeep/graphiql"
)

func main() {
	
	graphiqlHandler, err := graphiql.NewGraphiqlHandler("/graphql")
	if err != nil {
		panic(err)
	}
	
	http.HandleFunc("/graphql", myGraphQLHandler)
	http.Handle("/graphiql", graphiqlHandler)
	http.ListenAndServe(":8080", nil)
}

Use GraphiQL standalone

If you want launch GraphiQL for use on your GraphQL API but you don't want include it in your own project you can launch your own GraphiQL Server:

package main

import(
	"net/http"
	"github.com/ubeep/graphiql"
)

func main() {
	graphiqlHandler, err := graphiql.NewGraphiqlHandler("http://localhost:8080/graphql")
	if err != nil {
    		panic(err)
	}
    	
	
	http.Handle("/graphiql", graphiqlHandler)
	http.ListenAndServe(":4040", nil)
}

Contribute

Contributions are more than welcome, if you are interested please fork this repo and send your Pull Request.

License

MIT License, see LICENSE

Documentation

Index

• type Handler
  • func NewGraphiqlHandler(endpoint string) (*Handler, error)
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Types

type Handler

type Handler struct {
	Endpoint string
	// contains filtered or unexported fields
}

Handler define the struct of graphiql server

func NewGraphiqlHandler

func NewGraphiqlHandler(endpoint string) (*Handler, error)

The endpoint is the url where you have your graphql api hosted

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP is a handler function for resolve graphiql client on servers