docs(api): auto generate via annotations

.github/workflows/ci.yml

@@ -47,7 +47,9 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
       - name: Build
-        run: go build -ldflags "-X main.version=${{ github.ref_name }}" -o main .
+        run: |
+          make swag
+          go build -ldflags "-X main.version=${{ github.ref_name }}" -o main .
 
   build-container:
     name: Build Container

.gitignore

@@ -19,4 +19,7 @@
 /dev
 
 # Generated files
-*_mock_test.go
+*_mock_test.go
+
+# Generated Swagger Docs
+api/swagger.yaml

Makefile

@@ -19,3 +19,8 @@ run:
 
 plantuml:
 	plantuml -tsvg *.md docs/*.md docs/plugins/*.md docs/*.plantuml docs/plugins/*.plantuml
+
+swag:
+	go install github.com/swaggo/swag/cmd/swag@latest
+	swag fmt -g internal/plugin/api/api.go
+	swag init -o api/ -g internal/plugin/api/api.go -ot yaml

api/embed.go

@@ -2,5 +2,5 @@ package api
 
 import _ "embed"
 
-//go:embed openapi.yaml
-var OpenAPISpecs []byte
+//go:embed swagger.yaml
+var SwaggerSpecs []byte

build/package/Dockerfile

@@ -4,6 +4,7 @@ ARG VERSION
 COPY . /infrared
 WORKDIR /infrared
 ENV GO111MODULE=on
+RUN make swag
 RUN CGO_ENABLED=0 go build -ldflags "-X main.version=$VERSION" -o /main .
 
 FROM alpine:latest

cmd/root.go

@@ -224,6 +224,8 @@ func onConfigChange(cfg map[string]any) {
 	mu.Lock()
 	defer mu.Unlock()
 
+	logger.Info("reloading configs")
+
 	javaPrxCfg, err := java.NewProxyConfigFromMap(cfg)
 	if err != nil {
 		logger.Error("failed to load java config",
@@ -245,7 +247,7 @@ func onConfigChange(cfg map[string]any) {
 		infrared.BedrockEdition: bedrockPrxCfg,
 	}
 
-	logger.Debug("Reloading proxies")
+	logger.Debug("reloading proxies")
 	for n, p := range proxies {
 		if err := p.Reload(prxCfgs[n]); err != nil {
 			logger.Error("failed to reload proxy",
@@ -254,6 +256,6 @@ func onConfigChange(cfg map[string]any) {
 		}
 	}
 
-	logger.Debug("Reloading plugins")
+	logger.Debug("reloading plugins")
 	pluginManager.ReloadPlugins(cfg)
 }

configs/proxies/defaults.yml

@@ -45,7 +45,7 @@ defaults:
       
       # The message that is displayed to a client when they try to connect via an invalid domain.
       #
-      serverNotFoundMessage: Sorry {{username}}, but a server for {{serverDomain}} does not exist.
+      serverNotFoundMessage: Sorry {{username}}, but a server for {{requestedAddress}} does not exist.
 
     # Servers are server configurations that redirect players to a minecraft server.
     #
@@ -65,7 +65,7 @@ defaults:
       listener:
         # The message that is displayed to a client when they try to connect via an invalid domain.
         #
-        serverNotFoundMessage: Sorry {{username}}, but {{serverDomain}} was not found.
+        serverNotFoundMessage: Sorry {{username}}, but {{requestedAddress}} was not found.
 
         # The Java Edition has a different approach to handling status pings, than the Bedrock Edition.
         # This makes it possible to display a custom message to clients if the domain that they want
@@ -81,7 +81,7 @@ defaults:
           iconPath: icons/default.png
           motd: |
             Powered by Infrared
-            §c{{serverDomain}} was not found.
+            §c{{requestedAddress}} was not found.
     server:
       overrideAddress: true
       dialTimeout: 1s
@@ -97,7 +97,7 @@ defaults:
         iconPath: icons/default.png
         motd: |
           Powered by Infrared
-          §6Server at {{serverDomain}} is not responding.
+          §6Server at {{requestedAddress}} is not responding.
       
       # Infrared caches the server ping response so that status pings don't spam the minecraft server.
       # This is the Time To Live of the cache. Set this to <=0 to disable caching.

deployments/docker-compose.prod.yml

@@ -10,6 +10,10 @@ services:
       - 25565:25565/tcp
       # Port for Bedrock Edition
       - 19132:19132/udp
+      # API
+      #- 8080:8080/tcp
+      # Prometheus
+      #- 9070:9070/tcp
     volumes:
       - ./data/infrared:/infrared
       #- /var/run/docker.sock:/var/run/docker.sock:ro

deployments/docker-compose.test.yml

@@ -11,6 +11,8 @@ services:
     ports:
       - 25565:25565/tcp
       - 19132:19132/udp
+      - 8080:8080/tcp
+      - 9070:9070/tcp
     volumes:
       - ../dev:/infrared
       - /var/run/docker.sock:/var/run/docker.sock:ro