User facing API #

wtf-go

v0.1.0

#GET `/misc/version`

Return the version

Miscellaneous

Responses

gostringrequired

Version of the Go toolchain that built the binary

platformstringrequired

modifiedbooleanrequired

True or false indicating whether the source tree had local modifications

revisionstring

The revision identifier for the current commit or checkout.

timestring

The modification time associated with revision, in RFC3339 format

Request

curl -X GET "http://localhost:8081/api/v0/misc/version" \  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8081/api/v0/misc/version", {  method: "GET",  headers: {    "Content-Type": "application/json",  },});const data = await response.json();

import requestsresponse = requests.get("http://localhost:8081/api/v0/misc/version")data = response.json()

req, err := http.NewRequest("GET", "http://localhost:8081/api/v0/misc/version", nil)if err != nil {    log.Fatal(err)}req.Header.Set("Content-Type", "application/json")client := &http.Client{}resp, err := client.Do(req)if err != nil {    log.Fatal(err)}defer resp.Body.Close()

Response

{
  "go": "go1.20.3",
  "modified": true,
  "platform": "linux/amd64",
  "revision": "d4e5f6a",
  "time": "2024-10-06T09:25:27Z"
}

#GET `/misc/health`

Return the health status of the API

Miscellaneous

Responses

statusstringrequired

503 The API is currently unavailable

Request

curl -X GET "http://localhost:8081/api/v0/misc/health" \  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8081/api/v0/misc/health", {  method: "GET",  headers: {    "Content-Type": "application/json",  },});const data = await response.json();

import requestsresponse = requests.get("http://localhost:8081/api/v0/misc/health")data = response.json()

req, err := http.NewRequest("GET", "http://localhost:8081/api/v0/misc/health", nil)if err != nil {    log.Fatal(err)}req.Header.Set("Content-Type", "application/json")client := &http.Client{}resp, err := client.Do(req)if err != nil {    log.Fatal(err)}defer resp.Body.Close()

Response

{
  "status": "OK"
}

User facing API #

wtf-go

#GET /misc/version

Responses

#GET /misc/health

Responses

#GET `/misc/version`

#GET `/misc/health`