Merge pull request #20 from ClusterCockpit/Enable-Swagger-documentati…

…on-for-REST-api

Enable swagger documentation for rest api

.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.x
+          go-version: 1.22.x
       - name: Checkout code
         uses: actions/checkout@v3
       - name: Build, Vet & Test

Makefile

@@ -4,14 +4,19 @@ GIT_HASH := $(shell git rev-parse --short HEAD || echo 'development')
 CURRENT_TIME = $(shell date +"%Y-%m-%d:T%H:%M:%S")
 LD_FLAGS = '-s -X main.date=${CURRENT_TIME} -X main.version=${VERSION} -X main.commit=${GIT_HASH}'
 
-.PHONY: clean test tags $(TARGET)
+.PHONY: clean test tags swagger $(TARGET)
 
 .NOTPARALLEL:
 
 $(TARGET):
 	$(info ===>  BUILD cc-metric-store)
 	@go build -ldflags=${LD_FLAGS} ./cmd/cc-metric-store
 
+swagger:
+	$(info ===>  GENERATE swagger)
+	@go run github.com/swaggo/swag/cmd/swag init -d ./internal/api,./internal/util -g api.go -o ./api
+	@mv ./api/docs.go ./internal/api/docs.go
+
 clean:
 	$(info ===>  CLEAN)
 	@go clean