Using neelance/graphql-go

Author: ulm0

.gitlab-ci.yml

@@ -7,18 +7,16 @@ stages:
   stage: test-build
   script:
     - apk add --no-cache build-base git bash
-    - go get -d gitlab.com/klud/graphql-docker-api/cmd/gql-dkr
-    - cd /go/src/gitlab.com/klud/graphql-docker-api/cmd/gql-dkr
+    - mkdir -p /go/src/gitlab.com/klud/graphql-docker-api/
+    - cp -r ./ /go/src/gitlab.com/klud/graphql-docker-api/
+    - cd /go/src/gitlab.com/klud/graphql-docker-api/cmd/gdapi
     - go get -d ./
-    - cd /go/src/github.com/mastertinner
-    - rm -rf handler
-    - git clone -b feature/graphiql https://github.com/mastertinner/handler.git
-    - cd -
     - CGO_ENABLED=0 GOOS=linux go build -a -ldflags="-s -w" -installsuffix cgo
+    - cp -a gdapi /builds/klud/graphql-docker-api/
   artifacts:
     name: "$CI_JOB_NAME"
     paths:
-      - go/src/gitlab.com/klud/graphql-docker-api/cmd/gql-dkr/gql-dkr
+      - /builds/klud/graphql-docker-api/gdapi
     expire_in: 1 week
 
 .images: &images

Dockerfile

@@ -5,18 +5,12 @@ RUN apk add --no-cache git build-base && \
     echo "http://dl-cdn.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories && \
     apk add --no-cache upx
 ADD . /go/src/gitlab.com/klud/graphql-docker-api/
-WORKDIR /go/src/gitlab.com/klud/graphql-docker-api/cmd/gql-dkr
+WORKDIR /go/src/gitlab.com/klud/graphql-docker-api/cmd/gdapi
 RUN go get -d ./ && \
-#   Tweaking binary build process, until github.com/mastertinner/handler changes are merged
-    cd /go/src/github.com/mastertinner && \
-    rm -rf handler && \
-    git clone -b feature/graphiql https://github.com/mastertinner/handler.git && \
-    cd - && \
-#   Tweaking binary build process, until github.com/mastertinner/handler changes are merged
     CGO_ENABLED=0 GOOS=linux go build -a -ldflags="-s -w" -installsuffix cgo && \
-#   upx --best -qq gql-dkr && \
-    upx --ultra-brute -qq gql-dkr && \
-    upx -t gql-dkr
+#   upx --best -qq gdapi && \
+    upx --ultra-brute -qq gdapi && \
+    upx -t gdapi
 
 FROM scratch
 # Build-time metadata as defined at http://label-schema.org
@@ -37,6 +31,6 @@ ENV API_ENDPOINT="" \
     DOCKER_HOST="" \
     GQL_PORT="" \
     GRAPHIQL=""
-COPY --from=build-env /go/src/gitlab.com/klud/graphql-docker-api/cmd/gql-dkr/gql-dkr .
+COPY --from=build-env /go/src/gitlab.com/klud/graphql-docker-api/cmd/gdapi/gdapi .
 EXPOSE 8080
-CMD ["/gql-dkr"]
+CMD ["/gdapi"]

Gopkg.lock

@@ -1,8 +1,12 @@
+# Note!!!
+
+Since this project is in very early stage and due to [graphql-go/graphql](https://github.com/graphql-go/graphql)'s **overwhelming verbosity** the project is migrating to [neelance/graphql-go](https://github.com/neelance/graphql-go), which is more idiomatic and easy to use. ***This branch is gonna be used for such purposes.***
+
 # GraphQL Docker API
 
-[![pipeline status](https://gitlab.com/klud/graphql-docker-api/badges/master/pipeline.svg)](https://gitlab.com/klud/graphql-docker-api/commits/master) [![](https://images.microbadger.com/badges/version/klud/docker-gql.svg)](https://microbadger.com/images/klud/docker-gql "Get your own version badge on microbadger.com") [![](https://images.microbadger.com/badges/image/klud/docker-gql.svg)](https://microbadger.com/images/klud/docker-gql "Get your own image badge on microbadger.com") [![Go Report Card](https://goreportcard.com/badge/gitlab.com/klud/graphql-docker-api)](https://goreportcard.com/report/gitlab.com/klud/graphql-docker-api) [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE)
+[![pipeline status](https://gitlab.com/klud/graphql-docker-api/badges/migrate-lib/pipeline.svg)](https://gitlab.com/klud/graphql-docker-api/commits/migrate-lib) [![Go Report Card](https://goreportcard.com/badge/gitlab.com/klud/graphql-docker-api)](https://goreportcard.com/report/gitlab.com/klud/graphql-docker-api) [![](https://images.microbadger.com/badges/version/klud/docker-gql:0.1.0-rc.svg)](https://microbadger.com/images/klud/docker-gql:0.1.0-rc "Get your own version badge on microbadger.com") [![](https://images.microbadger.com/badges/image/klud/docker-gql:0.1.0-rc.svg)](https://microbadger.com/images/klud/docker-gql:0.1.0-rc "Get your own image badge on microbadger.com") [![Docker Pulls](https://img.shields.io/docker/pulls/klud/docker-gql.svg)](https://hub.docker.com/r/klud/docker-gql/) [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE)
 
-<p align="center"> <img src="resources/docker-go-graphql.png" alt="Logo" width="400"></p>
+![Logo](resources/docker-go-graphql_400.png)
 
 > A GraphQL Server for the Docker API, written in Golang.
 
@@ -11,16 +15,16 @@
 * Schema files can be found [here](resources/schema).
 * You can check the query-ready fields in the [TODO list](#todo)
 
-**Note**: It's important to keep this schema synced with the types implemented in the wrapper, best efforts are made in order to keep it so. That being said, You need to know *this schema is subject to change* as the time goes by and new changes are introduced in the Docker API and this wrapper as well.
+**Note**: It's important to keep this schema synced with the types implemented in the wrapper, best efforts are made in order to keep it so. That being said, You need to know ***this schema is subject to change*** as the time goes by and new changes are introduced in the Docker API and this wrapper as well.
 
 ## Getting Started
 
 ### Building from source
 
-* Get the package: `go get -d gitlab.com/klud/graphql-docker-api/cmd/gql-dkr`
+* Get the package: `go get -d gitlab.com/klud/graphql-docker-api/cmd/gdapi`
 * Dependencies
-  * **Not using [`dep`](README.md#open-source-libraries-and-tools).** Go to the project folder with `cd $GOPATH/src/gitlab.com/klud/graphql-docker-api/cmd/gql-dkr` and `go get -d ./`, this will download the depedencies needed, once that's done build the package with `go build`.
-  * **Using [`dep`](README.md#open-source-libraries-and-tools).** Go to the project folder with `cd $GOPATH/src/gitlab.com/klud/graphql-docker-api`, and run `dep install`, now get to `$GOPATH/src/gitlab.com/klud/graphql-docker-api/cmd/gql-dkr` and build the package with `go build`.
+  * **Not using [`dep`](README.md#open-source-libraries-and-tools).** Go to the project folder with `cd $GOPATH/src/gitlab.com/klud/graphql-docker-api/cmd/gdapi` and `go get -d ./`, this will download the depedencies needed, once that's done build the package with `go build`.
+  * **Using [`dep`](README.md#open-source-libraries-and-tools).** Go to the project folder with `cd $GOPATH/src/gitlab.com/klud/graphql-docker-api`, and run `dep install`, now get to `$GOPATH/src/gitlab.com/klud/graphql-docker-api/cmd/gdapi` and build the package with `go build`.
 
 **That's pretty much it. Congrats You have GraphQL Docker API on your system now.**
 
@@ -32,7 +36,7 @@
 docker run -d \
 --name docker-gql \
 -p 8080:8080 \
--e API_ENDPOINT="/api" \
+-e UI_ENDPOINT="/api" \
 -v /var/run/docker.sock:/var/run/docker.sock \
 klud/docker-gql
 ```
@@ -47,7 +51,7 @@ klud/docker-gql
 docker run -d \
 --name docker-gql \
 -p 8080:8080 \
--e API_ENDPOINT="/api" \
+-e UI_ENDPOINT="/api" \
 -e DOCKER_HOST="http://<host>:<port>" \
 klud/docker-gql
 ```
@@ -58,25 +62,26 @@ klud/docker-gql
 docker run -d \
 --name docker-gql \
 -p 8080:8080 \
--e API_ENDPOINT="/api" \
+-e UI_ENDPOINT="/api" \
 -e DOCKER_HOST="https://<host>:<port>" \
 -v /path/to/folder/containing/the/docker/certs:/etc/docker \
 klud/docker-gql
 ```
 
 ## Environment variables
 
-* `API_ENDPOINT`: Endpoint the API will work on (default: `"/graphql"`).
 * `DOCKER_CERT_PATH`: When using safe connection to Docker Remote API.
 * `DOCKER_HOST`: Host the API will retrieve information from (default: `"/var/run/docker.sock"`).
 * `GQL_PORT`: Port the API will listen on (default: `":8080"`).
-* `GRAPHIQL`: UI to execute queries in the browser. It's enabled by default, `GRAPHIQL=0` disables it.
+* `GRAPHIQL`: It's enabled by default, `GRAPHIQL=0` must be set in order to disable it.
+* `UI_ENDPOINT`: Endpoint GraphiQL will work on (default: `"/graphql"`).
 
 ### Notes
 
 * If using a Docker Remote API, this must be specified with the either HTTP or HTTPS protocols (e.g,: `DOCKER_HOST="http://<host>:<port>"`).
 * When using HTTPS, the TLS certs must be placed in `/etc/docker` or the `/path/to/folder/containing/the/docker/certs` must be mounted under `/etc/docker` inside the running container, and must follow the semantics behind the [DOCKER_CERT_PATH](https://docs.docker.com/engine/security/https/#create-a-ca-server-and-client-keys-with-openssl) env var.
-* `GRAPHIQL` can be reached at the `API_ENDPOINT`; disabling is advised when using in production.
+* `GRAPHIQL` can be reached at the `UI_ENDPOINT`; disabling is advised when using in production.
+* If GraphiQL is disabled, `UI_ENDPOINT` must not be set at all.
 
 ## TODO
 
@@ -105,13 +110,10 @@ klud/docker-gql
 
 ## Open-Source libraries and tools
 
-* [Dep](https://github.com/golang/dep) for *vendoring* dependencies
-* [Docker Client](https://github.com/moby/moby/tree/master/client)
-* [GraphQL](http://graphql.org)
-* [Golang](https://golang.org/)
-* [Go GraphQL](https://github.com/graphql-go/graphql)
-* [Go GraphQL handler](https://github.com/graphql-go/handler)
-* [Gorilla handlers](https://github.com/gorilla/handlers)
+* [docker/client](https://github.com/moby/moby/tree/master/client)
+* [neelance/graphql-go](https://github.com/neelance/graphql-go)
+* [gorilla/handlers](https://github.com/gorilla/handlers) for console logging.
+* [golang/dep](https://github.com/golang/dep) for *vendoring* dependencies.
 
 ---
 > Inspired by [rm3l/docker-api-graphql](https://github.com/rm3l/docker-api-graphql)