Skip to content

OpenAPI schema: add command to generate schema #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frozenhelium merged 1 commit into from
Apr 2, 2026
Merged

OpenAPI schema: add command to generate schema #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,12 @@ curl http://localhost:8080/openapi.json

The schema is generated dynamically using kin-openapi based on Go structs.

### Generate `openapi.json` using commandline

```bash
go run . --schema
```


## Database

Expand Down
25 changes: 25 additions & 0 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"context"
"encoding/json"
"flag"
"fmt"
"log/slog"
Expand All @@ -15,8 +16,32 @@ import (

func main() {
healthcheck := flag.Bool("healthcheck", false, "run a quick health probe and exit")
schema := flag.Bool("schema", false, "generate a openapi.json file and exit")

flag.Parse()

if *schema {
openapiSchema, err := buildOpenAPISpec("/")
if err != nil {
fmt.Fprintln(os.Stderr, err.Error())
os.Exit(1)
}

// Convert to JSON bytes
fileData, jsonErr := json.MarshalIndent(openapiSchema, "", " ")
if jsonErr != nil {
fmt.Fprintln(os.Stderr, jsonErr.Error())
os.Exit(1)
}

fileErr := os.WriteFile("openapi.json", fileData, 0644)
if fileErr != nil {
fmt.Fprintln(os.Stderr, fileErr.Error())
os.Exit(1)
}
os.Exit(0)
}

cfg := LoadConfig()
logger := newLogger(cfg.LogLevel)

Expand Down
327 changes: 327 additions & 0 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,327 @@
{
"info": {
"title": "cacheppuccino",
"version": "0.1.0"
},
"openapi": "3.0.3",
"paths": {
"/healthz": {
"get": {
"operationId": "getHealthz",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"nullable": true,
"properties": {
"status": {
"type": "string"
}
},
"type": "object"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "OK"
},
"default": {
"description": ""
}
},
"summary": "Liveness endpoint"
}
},
"/openapi.json": {
"get": {
"operationId": "getOpenAPI",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"description": "OK"
},
"default": {
"description": ""
}
},
"summary": "OpenAPI schema"
}
},
"/readyz": {
"get": {
"operationId": "getReadyz",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"nullable": true,
"properties": {
"status": {
"type": "string"
}
},
"type": "object"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "Ready"
},
"503": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"nullable": true,
"properties": {
"code": {
"type": "string"
},
"details": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "Not ready"
},
"default": {
"description": ""
}
},
"summary": "Readiness endpoint"
}
},
"/status": {
"get": {
"operationId": "getStatus",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"nullable": true,
"properties": {
"last_hash": {
"type": "string"
},
"last_pull": {
"type": "string"
},
"ready": {
"type": "boolean"
}
},
"type": "object"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "OK"
},
"default": {
"description": ""
}
},
"summary": "Service status"
}
},
"/strings": {
"get": {
"operationId": "getStrings",
"parameters": [
{
"description": "Language code (e.g. en, fr, es).",
"example": "en",
"in": "query",
"name": "lang",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Repeatable page param. Example: /strings?page=home\u0026page=about\u0026lang=en",
"example": "home",
"explode": true,
"in": "query",
"name": "page",
"schema": {
"type": "string"
},
"style": "form"
},
{
"description": "Comma-separated pages. Example: /strings?pages=home,about\u0026lang=en",
"example": "home,about",
"in": "query",
"name": "pages",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"nullable": true,
"properties": {
"lang": {
"type": "string"
},
"pages": {
"items": {
"type": "string"
},
"type": "array"
},
"strings": {
"additionalProperties": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"nullable": true,
"properties": {
"code": {
"type": "string"
},
"details": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "Bad request"
},
"500": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"nullable": true,
"properties": {
"code": {
"type": "string"
},
"details": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "Internal error"
},
"default": {
"description": ""
}
},
"summary": "Get strings for one or more pages in a given language"
}
}
},
"servers": [
{
"url": "/"
}
]
}
Loading