The easiest way to make API documents for GraphQL

Document Generator for GraphQL

gqldoc is now alpha

gqldoc is command line tool to generate documents from GraphQL schema or your GraphQL endpoint. the command is written by Go 1.16. So You need Go 1.16 and above If you want to build.

Demo

How to use

Generate docs from graphql endpoint

You need to enable GraphQL Introspection. --header and --query options are supported.

$ gqldoc -e http://127.0.0.1:8081/query --header 'Authorization: Bearer token' -o ./doc_dir

Generate docs from graphql schema files

Supported .json and .graphql, .gql extensions. .json must be contained the result of introspection.

$ gqldoc -s schema.graphql -o ./doc_dir

If you want to specify multiple schema, you can use --schema flag repeatedly.

$ gqldoc -s a.graphql -s b.graphql -o ./doc_dir

You can also use glob.

$ gqldoc -s "schema/**/*.graphql" -o ./doc_dir

Installation

Mac and Linux users via Homebrew

$ brew install Code-Hex/tap/gqldoc

Manually via go command

Again, this tool is supported Go 1.16 and above. If you are one of those users, you can install like below.

$ go install github.com/Code-Hex/gqldoc/cmd/gqldoc@latest

Manually download

You can download binary from here

Todo

This todo list is written the order of priority.

  • GitHub Actions for this Available
  • Subscription
  • Directive and it's location.
  • Put README.md in output directory
    • TOC purpose
  • Custom Template
  • Render HTML
    • I'm wondering if I should really support this feature.
Owner
Kei Kamikawa
Okinawapm, Previous: Mercari, Inc.
Kei Kamikawa
Comments
  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • want installation instruction

    want installation instruction

    Hi, thank you for awesome tool! I want to try this tool, but it seems there's no cmd/gqldoc/main.go or gqldoc/main.go. Please add them and give an installation instruction on README.md.

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • 项目引用了gopkg.in/yaml.v2等62个开源组件,存在6个漏洞,建议升级

    项目引用了gopkg.in/yaml.v2等62个开源组件,存在6个漏洞,建议升级

    大佬,看你这个项目调用了gopkg.in/yaml.v2等62个开源组件,存在6个安全漏洞,建议你升级下。

    漏洞标题:Google Kubernetes API Server 资源管理错误漏洞
    漏洞编号:CVE-2019-11254
    漏洞描述:
    Google Kubernetes是美国谷歌(Google)公司的一套开源的Docker容器集群管理系统。该系统为容器化的应用提供资源调度、部署运行、服务发现和扩容缩容等功能。API server是其中的一个API(应用编程接口)服务器。
    Google Kubernetes 1.15.10之前版本、1.16.7之前版本和1.17.3之前版本中的API Server组件存在资源管理错误漏洞。远程攻击者可借助特制请求利用该漏洞造成拒绝服务。
    国家漏洞库信息:https://www.cnvd.org.cn/flaw/show/CNVD-2020-35519
    影响范围:(∞, 2.2.8)
    最小修复版本:2.2.8
    引入路径:
    github.com/Code-Hex/gqldoc@->github.com/99designs/[email protected]>github.com/urfave/cli/[email protected]>gopkg.in/[email protected]
    github.com/Code-Hex/gqldoc@->github.com/urfave/cli/[email protected]>gopkg.in/[email protected]
    

    另外5个漏洞 ,信息有点多我就不贴了,你自己看下完整报告:https://www.mfsec.cn/jr?p=a726e6 你对这个issues有任何疑问可以回复我,我能看见哈。

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

  • 🚧 🤖📯 GraphQL Schema changed

    🚧 🤖📯 GraphQL Schema changed

    I found new changes in GitHub's GraphQL Schema 👋🤖 I can't tell if the changes are fixes, features or breaking, you'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.

go generate based graphql server library
go generate based graphql server library

gqlgen What is gqlgen? gqlgen is a Go library for building GraphQL servers without any fuss. gqlgen is based on a Schema first approach — You get to D

Dec 29, 2022
This is Go library for building GraphQL client with gqlgen

gqlgenc What is gqlgenc ? This is Go library for building GraphQL client with gqlgen Motivation Now, if you build GraphQL api client for Go, have choi

Jan 7, 2023
A port of the parser from graphql-js into golang

gqlparser This is a parser for graphql, written to mirror the graphql-js reference implementation as closely while remaining idiomatic and easy to use

Dec 27, 2022
gqlanalysis makes easy to develop static analysis tools for GraphQL in Go.
gqlanalysis makes easy to develop static analysis tools for GraphQL in Go.

gqlanalysis gqlanalysis defines the interface between a modular static analysis for GraphQL in Go. gqlanalysis is inspired by go/analysis. gqlanalysis

Dec 14, 2022
libraries for various programming languages that make it easy to generate per-process trace files that can be loaded into chrome://tracing
libraries for various programming languages that make it easy to generate per-process trace files that can be loaded into chrome://tracing

chrometracing: chrome://tracing trace_event files The chrometracing directory contains libraries for various programming languages that make it easy t

Oct 6, 2022
A collection of small Go utilities to make life easier.

The simplego package provides a collection of Go utilities for common tasks.

Jan 4, 2023
Make Go functional with dogs
Make Go functional with dogs

dogs Make Go functional with dogs Caution This is a highly-experimental package. Any changes will be made in a backward-incompatible manner. This pack

Jan 4, 2023
make slice items unique in go

make slice items unique in go

Jan 20, 2022
How much you spend for glovo. Make config file and launch yourself

how_much_you_spend How much you spend for glovo. Make config file and launch yourself, you are welcome! Put config file in the same folder as executab

Nov 9, 2021
An easy way to getsystem by golang.
An easy way to getsystem by golang.

doge-getsys An easy way to getsystem by golang. getsystem From administrator to System usage doge-getsys.exe open a new cmd window in system privileg

Jan 1, 2023
Easy way to get credentials of your clusters in GCP and stay connected

Easy way to get credentials of your clusters in GCP and stay connected. Don't lose time with alias or annotations with projects names and clusters. Use k8skey

Nov 9, 2021
Go API backed by the native Dart Sass Embedded executable.

This is a Go API backed by the native Dart Sass Embedded executable. The primary motivation for this project is to provide SCSS support to Hugo. I wel

Jan 5, 2023
A pluggable backend API that enforces the Event Sourcing Pattern for persisting & broadcasting application state changes
A pluggable backend API that enforces the Event Sourcing Pattern for persisting & broadcasting application state changes

A pluggable "Application State Gateway" that enforces the Event Sourcing Pattern for securely persisting & broadcasting application state ch

Nov 1, 2022
reflect api without runtime reflect.Value cost

reflect2 reflect api that avoids runtime reflect.Value cost reflect get/set interface{}, with type checking reflect get/set unsafe.Pointer, without ty

Jan 4, 2023
Cross-platform Bluetooth API for Go and TinyGo.
Cross-platform Bluetooth API for Go and TinyGo.

Go Bluetooth is a cross-platform package for using Bluetooth Low Energy hardware from the Go programming language.

Jan 6, 2023
this is an api that execute your deno code and send you the output

this a simple api that execute your deno code and send you the output, has not limit per request example request: in deno: const rawResponse = await f

Dec 23, 2022
Go scripts for finding an API key / some keywords in repository
Go scripts for finding an API key / some keywords in repository

Git-Secret Go scripts for finding an API key / some keywords in repository Update V1.0 ?? Added some API Key checker Screenshoot ?? How to Install go

Dec 30, 2022
🚀 Use Lanyard API easily in your Go app!

?? Go Lanyard Use Lanyard API easily in your Go app! ?? Installation Initialize your project (go mod init example.com/example) Add package (go get git

Mar 11, 2022
An Api for Task by Appointy made using go.

AppointyTask API How to Compile Export All the required environment variables. MONGO_URI = Database URI PORT = Port to run the server on DATABA

Oct 10, 2021