From 4c93dc2ae3a857defea3a7b8d9ea60706cfbefe8 Mon Sep 17 00:00:00 2001 From: Javier Marcos <1271349+javuto@users.noreply.github.com> Date: Thu, 28 May 2026 14:39:05 +0200 Subject: [PATCH] Generator of swagger YAML and JSON using Makefile --- Makefile | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 3e2e00f9..324f71a6 100644 --- a/Makefile +++ b/Makefile @@ -28,8 +28,10 @@ DIST = dist STATIC_ARGS = -ldflags "-linkmode external -extldflags -static" BUILD_ARGS = -ldflags "-s -w -X main.buildCommit=$(shell git rev-parse HEAD) -X main.buildDate=$(shell date -u +%Y-%m-%dT%H:%M:%SZ)" +SWAG_VERSION ?= v1.16.6 +SWAG = go run github.com/swaggo/swag/cmd/swag@$(SWAG_VERSION) -.PHONY: build static clean tls admin cli api release release-build release-check release-init clean-dist frontend frontend-install frontend-dev frontend-build frontend-test +.PHONY: build static clean tls admin cli api swagger release release-build release-check release-init clean-dist frontend frontend-install frontend-dev frontend-build frontend-test # Build code according to caller OS and architecture build: @@ -69,6 +71,10 @@ api: api-static: go build $(BUILD_ARGS) $(STATIC_ARGS) -o $(OUTPUT)/$(API_NAME) -a $(API_CODE) +# Generate Swagger 2.0 YAML and JSON files from API annotations +swagger: + $(SWAG) init -d $(API_DIR),$(API_DIR)/handlers,pkg/types,pkg/nodes,pkg/queries,pkg/environments,pkg/users,pkg/settings,pkg/tags,pkg/carves -g main.go -o $(API_DIR)/docs --outputTypes yaml,json --parseDependencyLevel 1 + # Build the CLI cli: go build $(BUILD_ARGS) -o $(OUTPUT)/$(CLI_NAME) $(CLI_CODE)