feat: enhance Makefile with documentation generation scripts

Author: TBXark

Makefile

@@ -1,3 +1,5 @@
+include scripts/Makefile.docs
+
 MODULE := $(shell go list -m)
 MODULE_NAME := $(lastword $(subst /, ,$(MODULE)))
 BUILD := $(shell git rev-parse --short HEAD)@$(shell date +%s)
@@ -10,7 +12,6 @@ DOCKER_FILE := cmd/app/Dockerfile
 LD_FLAGS := "-X $(MODULE)/internal/config.BuildVersion=$(BUILD)"
 GO_BUILD := CGO_ENABLED=0 go build -trimpath -ldflags $(LD_FLAGS) -tags=jsoniter
 
-
 .PHONY: init
 init: ## Init all dependencies
 	go mod download
@@ -39,13 +40,13 @@ gen-proto: ## Generate proto files and run protoc plugins
 
 .PHONY: gen-docs
 gen-docs: gen-proto ## Generate swagger docs
-	swag init --output ./swagger/api  --tags api.v1,shared.v1   --instanceName API  -g docs.go --parseDependency
-	swag init --output ./swagger/dash --tags dash.v1,shared.v1  --instanceName Dash -g docs.go --parseDependency
+	$(call gen_docs,api,API)
+	$(call gen_docs,dash,Dash)
 
 .PHONY: gen-ts
 gen-ts: gen-docs ## Generate typescript client
-	npx swagger-typescript-api -p ./swagger/api/API_swagger.json   -o ./swagger/api/typescript  --modular --responses --extract-response-body --extract-response-error
-	npx swagger-typescript-api -p ./swagger/dash/Dash_swagger.json -o ./swagger/dash/typescript --modular --responses --extract-response-body --extract-response-error
+	$(call gen_ts,api,API)
+	$(call gen_ts,dash,Dash)
 
 .PHONY: gen-ent
 gen-ent: ## Generate ent code
@@ -109,7 +110,6 @@ clean: ## Clean build files
 	rm -rf ./api
 	rm -rf ./internal/pkg/database/ent
 
-
 .PHONY: help
 help: ## Show this help message
 	@echo "\n\033[1mSphere build tool.\033[0m Usage: make [target]\n"

internal/server/dash/web.go

@@ -104,7 +104,7 @@ func (w *Web) Start(ctx context.Context) error {
 
 	systemRoute := needAuthRoute.Group("/")
 	dashv1.RegisterSystemServiceHTTPServer(systemRoute, w.service)
-	
+
 	userRoute := needAuthRoute.Group("/")
 	dashv1.RegisterUserServiceHTTPServer(userRoute, w.service)
 

scripts/Makefile.docs

@@ -0,0 +1,7 @@
+define gen_docs
+	swag init --output ./swagger/$(1) --tags $(1).v1,shared.v1 --instanceName $(2) -g docs.go --parseDependency
+endef
+
+define gen_ts
+	npx swagger-typescript-api -p ./swagger/$(1)/$(2)_swagger.json -o ./swagger/$(1)/typescript --modular --responses --extract-response-body --extract-response-error
+endef