doc.go

// Package eggql allows you to easily build a GraphQL server in Go.
// (EGGQL might be an acronym for Easy Go Graph Query Language.)

// It's easy because you don't have to worry about schemas and
// getting run-time panics due to inconsistencies between your
// GraphQL schema and the corresponding Go structures.  It effectively
// builds a GraphQL schema for you based on your data structures.
// For example, here is the code for a complete GraphQL server:

///////////////////////////////////////////////////////////////////////////////
//package main
//
//import (
//    "net/http"
//    "github.com/andrewwphillips/eggql"
//)
//func main() {
//	   http.Handle("/graphql", eggql.New(struct{ Message string }{"hello, world"}))
//	   http.ListenAndServe(":8080", nil)
//}
///////////////////////////////////////////////////////////////////////////////

// This creates a GraphQL root "Query" containing a field called "message".
// If you send a query (to http://localhost:8080/graphql) like this:
// {
//    message
// }
//
// you will get back this reply:
// {
//    "data": {
//      "message": "hello, world"
//    }
// }

// Of course, you can do much more sophisticated stuff, usually very easily, such
// as mutations with query parameters.  In fact, you can do most normal GraphQL
// stuff (including mutations and subscriptions).
// To create bullet-proof servers, resolver functions also (optionally) support a
// context parameter (of context.Context type) and error returns (of error type).

// See the README.md file for more details on using the package.

package eggql

// TODO:
// complexity limiting:
//   - add complexity(len, <int>, <arg>, <arg>) option
//     where len = length for field returning a list and the value *can* be precalculated
//           <int> = integer literal (eg 10)
//           <arg> = integer argument
//   -  calc complexity (recursively) before running a root query (if below option on) (eg <int>*<arg>*<arg>)
//   -  add complexity throttling option - so complex queries are not even attempted
// query aggregator to avoid N+1 problem (cf Apollo dataloader)
// add hooks for OpenTelemetry
// server-sent events for subscriptions
// look at why some GraphQL tools can't introspect the schema