borosr / graphql-docs

A helper project for go-graphql, to build html documentation from schema

GraphQL Docs

A helper project for go-graphql, to build html documentation from schema

Usage

GO111MODULE=on go get github.com/borosr/graphql-docs

package main

import (
 "github.com/borosr/graphql-docs"
 "github.com/graphql-go/graphql"
)


func main() {
    s, _ := graphql.NewSchema(graphql.SchemaConfig{
        Query: Query(), // some query
    })
    docs.Init(s, docs.Config{Html: true}) // creates returns the documentation's content
}

Config values:

Config{
    Sysout:   true,
    Pretty:   true,
    Html:     true,
    Md:       true,
    Json:     true,
    Filename: "graphql-docs",
}

Output on console (with Sysout: true, Pretty: true)

query{
	graph(repo:"",filter:{value:"",filterIn:""}){
		nodes{
			attributes{
				functions
				methods{
					name
					receiver{
						name
						fields{
							name
							type
						}
					}
				}
				structs{
					name
					fields{
						name
						type
					}
				}
			}
			title
			weight
			color
			font{
				color
			}
			id
			label
		}
		edges{
			from
			to
			arrows
			attributes{
				functions
				methods{
					name
					receiver{
						name
						fields{
							name
							type
						}
					}
				}
				structs{
					name
					fields{
						name
						type
					}
				}
			}
			title
		}
	}
}

Output in html or md

You can check them, after pulling this repo and a go test .

License

License