实现服务启动时自动生成OpenAPI文档
主要变更: 1. 新增 cmd/api/docs.go 实现文档自动生成逻辑 2. 修改 cmd/api/main.go 在服务启动时调用文档生成 3. 重构 cmd/gendocs/main.go 提取生成函数 4. 更新 .gitignore 忽略自动生成的 openapi.yaml 5. 新增 Makefile 支持 make docs 命令 6. OpenSpec 框架更新和变更归档 功能特性: - 服务启动时自动生成 OpenAPI 文档到项目根目录 - 保留独立的文档生成工具 (make docs) - 生成失败时记录错误但不影响服务启动 - 所有代码已通过 openspec validate --strict 验证 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
38
Makefile
Normal file
38
Makefile
Normal file
@@ -0,0 +1,38 @@
|
||||
.PHONY: run build test lint clean docs
|
||||
|
||||
# Go parameters
|
||||
GOCMD=go
|
||||
GOBUILD=$(GOCMD) build
|
||||
GOCLEAN=$(GOCMD) clean
|
||||
GOTEST=$(GOCMD) test
|
||||
GOGET=$(GOCMD) get
|
||||
BINARY_NAME=bin/junhong-cmp
|
||||
MAIN_PATH=cmd/api/main.go
|
||||
WORKER_PATH=cmd/worker/main.go
|
||||
WORKER_BINARY=bin/junhong-worker
|
||||
|
||||
all: test build
|
||||
|
||||
build:
|
||||
$(GOBUILD) -o $(BINARY_NAME) -v $(MAIN_PATH)
|
||||
$(GOBUILD) -o $(WORKER_BINARY) -v $(WORKER_PATH)
|
||||
|
||||
test:
|
||||
$(GOTEST) -v ./...
|
||||
|
||||
clean:
|
||||
$(GOCLEAN)
|
||||
rm -f $(BINARY_NAME)
|
||||
rm -f $(WORKER_BINARY)
|
||||
|
||||
run:
|
||||
$(GOBUILD) -o $(BINARY_NAME) -v $(MAIN_PATH)
|
||||
./$(BINARY_NAME)
|
||||
|
||||
run-worker:
|
||||
$(GOBUILD) -o $(WORKER_BINARY) -v $(WORKER_PATH)
|
||||
./$(WORKER_BINARY)
|
||||
|
||||
# Generate OpenAPI documentation
|
||||
docs:
|
||||
$(GOCMD) run cmd/gendocs/main.go
|
||||
Reference in New Issue
Block a user