Skip to content

Commit 5963b8c

Browse files
committed
feat: enhance Makefile with documentation generation scripts
1 parent 21a2fa3 commit 5963b8c

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
lines changed

Makefile

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
include scripts/Makefile.docs
2+
13
MODULE := $(shell go list -m)
24
MODULE_NAME := $(lastword $(subst /, ,$(MODULE)))
35
BUILD := $(shell git rev-parse --short HEAD)@$(shell date +%s)
@@ -10,7 +12,6 @@ DOCKER_FILE := cmd/app/Dockerfile
1012
LD_FLAGS := "-X $(MODULE)/internal/config.BuildVersion=$(BUILD)"
1113
GO_BUILD := CGO_ENABLED=0 go build -trimpath -ldflags $(LD_FLAGS) -tags=jsoniter
1214

13-
1415
.PHONY: init
1516
init: ## Init all dependencies
1617
go mod download
@@ -39,13 +40,13 @@ gen-proto: ## Generate proto files and run protoc plugins
3940

4041
.PHONY: gen-docs
4142
gen-docs: gen-proto ## Generate swagger docs
42-
swag init --output ./swagger/api --tags api.v1,shared.v1 --instanceName API -g docs.go --parseDependency
43-
swag init --output ./swagger/dash --tags dash.v1,shared.v1 --instanceName Dash -g docs.go --parseDependency
43+
$(call gen_docs,api,API)
44+
$(call gen_docs,dash,Dash)
4445

4546
.PHONY: gen-ts
4647
gen-ts: gen-docs ## Generate typescript client
47-
npx swagger-typescript-api -p ./swagger/api/API_swagger.json -o ./swagger/api/typescript --modular --responses --extract-response-body --extract-response-error
48-
npx swagger-typescript-api -p ./swagger/dash/Dash_swagger.json -o ./swagger/dash/typescript --modular --responses --extract-response-body --extract-response-error
48+
$(call gen_ts,api,API)
49+
$(call gen_ts,dash,Dash)
4950

5051
.PHONY: gen-ent
5152
gen-ent: ## Generate ent code
@@ -109,7 +110,6 @@ clean: ## Clean build files
109110
rm -rf ./api
110111
rm -rf ./internal/pkg/database/ent
111112

112-
113113
.PHONY: help
114114
help: ## Show this help message
115115
@echo "\n\033[1mSphere build tool.\033[0m Usage: make [target]\n"

internal/server/dash/web.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ func (w *Web) Start(ctx context.Context) error {
104104

105105
systemRoute := needAuthRoute.Group("/")
106106
dashv1.RegisterSystemServiceHTTPServer(systemRoute, w.service)
107-
107+
108108
userRoute := needAuthRoute.Group("/")
109109
dashv1.RegisterUserServiceHTTPServer(userRoute, w.service)
110110

scripts/Makefile.docs

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

0 commit comments

Comments
 (0)