Categorygithub.com/asif-mahmud/gingraphql
modulepackage
1.0.2
Repository: https://github.com/asif-mahmud/gingraphql.git
Documentation: pkg.go.dev

# README

GraphQL handler for gin

go workflow

This is a small package to provide a GraphQL handler that can be used with Gin Framework.

Features

  1. Fully tested.
  2. Supports context managers so user can add their application specific data to be used in resolver functions.
  3. Supports file upload out of the box.
  4. Fully compliant with GraphQL multipart specification, so client libraries like Apollo Upload Client will work out of the box.
  5. Allows adding additional http headers either by gin middleware, or right from the resolver functions.

Installation

To add the package to your project run -

go get -u github.com/asif-mahmud/gingraphql

Documentation

godoc: https://pkg.go.dev/github.com/asif-mahmud/gingraphql examples: https://pkg.go.dev/github.com/asif-mahmud/gingraphql#pkg-examples

Version history

Version 1.0.2

  • Updated go and package versions
  • Fixed github workflow
  • Fixed package name issue

Version 1.0.0

Stable version release

Version 0.9.0

A clone of the original package https://pkg.go.dev/github.com/asif-mahmud/graphqlgin to fix versioning.

# Functions

Extracts and returns the current `*gin.Context` value from the context `ctx`.
Returns a `ContextProviderFn` that will add the current `*gin.Context` value to the context passed down to resolver functions.
Constructs a new GraphQL app.

# Constants

Key for setting `*gin.Context` value of the current request to the context.

# Variables

GraphQL scalar to represent file upload variable.

# Structs

GraphQL app structure.
GraphQL request parameters including file upload maps and operations.
Basic GraphQL request parameters.

# Type aliases

Function to update or modify the context passed down to the resolver functions.