feat: Add example values to DTOs for improved API documentation

This commit is contained in:
2025-03-12 06:29:10 +00:00
parent c3162756ad
commit 016078c1c3
11 changed files with 668 additions and 341 deletions
+8 -2
View File
@@ -1,6 +1,6 @@
# Time Tracker Backend Makefile
.PHONY: db-start db-stop db-test model-test run build clean migrate seed help
.PHONY: db-start db-stop db-test model-test run build clean migrate seed swagger help
# Default target
.DEFAULT_GOAL := help
@@ -25,6 +25,7 @@ help:
@echo " make seed - Seed the database with initial data"
@echo " make db-drop-users - Drop the users table"
@echo " make db-reinit - Re-initialize the database"
@echo " make swagger - Generate swagger documentation"
@echo " make help - Show this help message"
# Start the database
@@ -88,7 +89,12 @@ db-drop-users:
db-reinit:
@echo "Re-initializing the database..."
@PG_HOST=$(DB_HOST) PG_PORT=$(DB_PORT) PG_USER=$(DB_USER) PG_PASSWORD=$(DB_PASSWORD) PG_DBNAME=$(DB_NAME) go run cmd/migrate/main.go -create_db -drop_db
@echo "Database re-initialized"
# Generate swagger documentation
swagger:
@echo "Generating swagger documentation..."
@swag init -g cmd/api/main.go
@echo "Swagger documentation generated"
help:
@echo "Time Tracker Backend Makefile"