goliteql

goliteql is a lightweight, schema-first GraphQL code generator tailored for Go (Golang). It streamlines the process of generating GraphQL server code based on the http.Handler interface and schema files, making it an efficient choice for developers looking to implement GraphQL functionality without the overhead of additional dependencies.

Key Features

• Lightweight Design: Minimal additional dependencies, relying primarily on the Go standard library or goliteql itself.
• Schema-First Approach: Prioritizes schema definitions, allowing for straightforward integration into existing applications.

Compatibility and Limitations

As of the October 2021 Edition of the GraphQL specification, goliteql supports the following features:

goliteql does not aim to function as a fully-featured GraphQL server. For those requiring comprehensive GraphQL capabilities, alternatives like gqlgen may be more suitable.

Example Usage

To demonstrate how to set up goliteql, consider the following example:

1. Create a new file named main.go with the following content:

package main

import (
	"net/http"
	"<your-module-name>/graphql/resolver"
)

func main() {
	r := resolver.NewResolver()
	http.ListenAndServe(":8080", r)
}

2. Define the Query Resolver in the file resolver/query.resolver.go:

package resolver

import (
	"context"
	"github.com/n9te9/goliteql/internal/generated/graphql/model"
)

type QueryResolver interface {
	Posts(ctx context.Context) ([]model.Node, error)
	Post(ctx context.Context, id string) (model.Post, error)
	Users(ctx context.Context) ([]model.User, error)
}

func (r *resolver) Posts(ctx context.Context) ([]model.Node, error) {
  // Example implementation of the Posts resolver
}

3. Run the server:

$ go run main.go

Performance Benchmark

When evaluated against other GraphQL code generators like gqlgen, goliteql shows significant performance advantages. The benchmarking results indicate that goliteql can generate ten posts at a remarkable speed of 19096 ns/op compared to gqlgen's 58628 ns/op:

$ go test -benchmem -v -bench .

Parsing Capabilities

For those interested in using goliteql solely as a parser, it can be easily integrated as follows:

package main

import (
	"github.com/n9te9/goliteql/schema"
)

func main() {
	lexer := schema.NewLexer()
	parser := schema.NewParser(lexer)

	ast, err := parser.Parse([]byte(`${Your schema}`))
	if err != nil {
		panic(err)
	}

	// ast is the abstract syntax tree of the schema
}

Contribution

Contributions to goliteql are welcomed. Interested contributors are encouraged to fork the repository and submit pull requests. Before adding new features, it is advisable to create an issue to facilitate discussion. Bugs should also be reported through issues for swift resolution.