• This repository has been archived on 01/Apr/2024
  • Stars
    star
    192
  • Rank 202,019 (Top 4 %)
  • Language
    Go
  • License
    MIT License
  • Created over 3 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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.

More Repositories

1

pget

The fastest, resumable file download client
Go
1,047
star
2

vz

Create virtual machines and run Linux-based operating systems in Go using Apple Virtualization.framework.
Go
569
star
3

go-generics-cache

A key:value store/cache library written in Go generics. LRU, LFU, FIFO, MRU, Clock support.
Go
458
star
4

graphql-codegen-typescript-validation-schema

GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema
TypeScript
313
star
5

synchro

🕰️ Synchro: Timezone-typesafe date and time framework for Go. 🌟 Star to support our work!
Go
260
star
6

Neo-cowsay

🐮 cowsay is reborn. Neo Cowsay has written in Go.
Go
246
star
7

dd

Data Dumper library dumps any data as valid syntax in Go
Go
185
star
8

firebase-auth-cloudflare-workers

TypeScript
131
star
9

battery

Display your battery status on terminal (or tmux) written by Go
Go
70
star
10

golet

*.go file as a mini supervisor
Go
60
star
11

funcy-mock

funcy-mock generates mock file from interface go file
Go
52
star
12

shibafu

Shibafu Programming Language wwwwwwwwwww
Go
41
star
13

container-registry

container-registry
Go
29
star
14

puipui-linux

So tiny linux for testing virtualization (Virtual I/O aka VIRTIO) purpose
Shell
24
star
15

fast-service

fast-service is opensource speedtest service written in Go
Go
24
star
16

testing-grpc

go-grpc server, client for onboarding
Go
23
star
17

go-install-tools

Install All go-tools at one time!!
Go
22
star
18

sqlx-transactionmanager

Transaction manager for github.com/jmoiron/sqlx
Go
22
star
19

White-MobileTerminal

Supports ios versions from 7.0 to 8.1 !!
C++
20
star
20

go-version-update

Update the version string of your go project.
Go
20
star
21

echo-static

Static middleware for echo web framework(golang)
Go
19
star
22

sigctx

context with signal in golang
Go
19
star
23

retrygroup

Package retrygroup provides synchronization, Context cancelation for groups of retry goroutines working on subtasks of a common task.
Go
17
star
24

sqb

⚡Blazing fast, Flexible, SQL Query Builder for Go
Go
17
star
25

gvisor-vmnet

vmnet based gvisor tcpip stack
Go
11
star
26

auto-milestone-binder

An action for binding milestone to some PR or some issues
TypeScript
8
star
27

dotfiles

大事なdotを管理してます👍
Shell
8
star
28

grpc-edge-gateway

gRPC Gateway on the edge functions
TypeScript
7
star
29

deno-context

🦕【Deno】Propagate deadlines, a cancellation and other request-scoped values to multiple promise.
TypeScript
6
star
30

neo-cowsay-action

🐮 GitHub action for cowsay lovers
Shell
5
star
31

takopi

っピ!
Go
5
star
32

socks5

socks5 server implemented by Go
Go
5
star
33

go-emojipacks

https://github.com/lambtron/emojipacks has been stopped. A new emojipacks has been implemented by Go
Go
5
star
34

saltissimo

Easy generate, easy compare hash using pbdkf2
Go
5
star
35

exit

Error makes exit code meaningful
Go
5
star
36

gqldoc-actions

JavaScript
5
star
37

code-hex.github.io

My homepage
TypeScript
5
star
38

Text-Shirasu

Wrapped Text::MeCab in Perl
Perl
5
star
39

go-async

More Easy, more readable sync.WaitGroup
Go
5
star
40

twippai

Perl、Python、RubyでTwitterからたくさんのおっぱいをダウンロードする
Go
4
star
41

go-infinity-channel

Provides an infinitely queueing channel.
Go
4
star
42

go-github-token

Very easy to get github access token library written in Go
Go
3
star
43

arm64-docker-mysql

Shell
3
star
44

uploader

uploader by grpc go
Go
3
star
45

HotKeyCapture

This is a sandboxed of custom global hotkeys in Swift using HotKeyCapture
Swift
3
star
46

ssh-gpt

Fictitious SSH Server - Powered by OpenAI ChatGPT
Go
3
star
47

chair

isucon tool
Go
2
star
48

Text-CaboCha

Alternate Text-CaboCha Binding
Perl
2
star
49

gpl

Update multiple local repositories with parallel
Go
2
star
50

p5-App-Format

Format for perl code. It's like a gofmt.
Perl
2
star
51

Card

テストを乗り切るために開発されたアプリ
Swift
2
star
52

m1-docker

Please following this URL
Go
2
star
53

network

Asynchronous Networking Patterns
Go
2
star
54

vegeta

Project to collect large amounts of vegetable data using IoT
Go
2
star
55

Algorithm-NaiveBayes-RandomForest

RandomForest with Algorithm::NaiveBayes in perl
Perl
1
star
56

go-groff

groff parser
Go
1
star
57

go-elisp

elisp implement by Go
Go
1
star
58

MyApplication

Implement NSApplication main-event-loop
Objective-C
1
star
59

first-label-interaction

Labeling actions for new comer
JavaScript
1
star
60

fmm

Friendly memory monitoring tool
C
1
star
61

touchbar-emoji

emoji on control strip
Objective-C
1
star
62

godzilla

Management tool for go
Go
1
star
63

alpine-chrome

Chrome Headless docker images built upon alpine
Dockerfile
1
star
64

ghp

Create a new project on the ghq root
Go
1
star
65

IF

Ternary operator package for Go
Go
1
star
66

Color-Capture

Color Capture is PopClip Extension
Objective-C
1
star
67

go-riscv

Go
1
star
68

p5-Shell-Tiny

Very tiny shell written in Perl5
Perl
1
star
69

august

gRPC to RESTful or Protobuf on HTTP proxy for microservices
1
star
70

tenpuzzle

Tenpuzzle - Find the solution of the 10 puzzles in Genetic Algorithm
Go
1
star
71

p5-XS-Closure-Example

Example for how to make a closure on XS
C
1
star
72

p5-List-Flatten-XS

Fast flatten
Perl
1
star