Draft 23.01.2020

Author: Vic Shóstak

.gitignore

@@ -19,3 +19,4 @@
 
 # Dev Build
 app/
+build/

Makefile

@@ -17,7 +17,7 @@ test:
 	@echo "$(GREEN)[OK]$(NOCOLOR) App backend was tested!"
 
 run:
-	@go run ./...
+	@go run ./cmd/$(NAME)/...
 
 build: clean
 	@CGO_ENABLED=0 GOARCH=amd64

internal/apiserver/apiserver.go

@@ -8,14 +8,14 @@ import (
 	"go.uber.org/zap"
 )
 
-// APIServer ...
+// APIServer struct
 type APIServer struct {
 	config *Config
 	logger *zap.Logger
 	router *mux.Router
 }
 
-// New ...
+// New method for init new server instance
 func New(config *Config) *APIServer {
 	return &APIServer{
 		config: config,
@@ -24,7 +24,7 @@ func New(config *Config) *APIServer {
 	}
 }
 
-// Start ...
+// Start method for start new server
 func (s *APIServer) Start() error {
 	// Starting message
 	s.logger.Info(

internal/apiserver/checker.go

@@ -5,7 +5,7 @@ import (
 	"os"
 )
 
-// IsError function for check error and show message
+// IsError method for check error and show message
 func (s *APIServer) IsError(err error) {
 	// If got error
 	if err != nil {

internal/apiserver/logger.go

@@ -7,7 +7,7 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
-// Logger ...
+// Logger function for init new zap logger instance
 func Logger(config *Config) *zap.Logger {
 	// Define log level
 	level := zap.NewAtomicLevel()

internal/apiserver/middleware.go

@@ -6,7 +6,7 @@ import (
 	"go.uber.org/zap"
 )
 
-// loggerMiddleware function middleware for logging
+// loggerMiddleware method for logging middleware
 func (s *APIServer) loggerMiddleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		// Show debug message

internal/apiserver/routes.go

@@ -21,7 +21,7 @@ type frontendHandler struct {
 	indexPath  string
 }
 
-// Router function for create router
+// Router method for create router
 func (s *APIServer) Router() {
 	// API routes with allowed methods
 	s.router.HandleFunc("/api/index", s.handleIndex()).Methods(http.MethodGet)
@@ -42,7 +42,7 @@ func (s *APIServer) Router() {
 	)
 }
 
-// handleIndex function handler for route /api/index
+// handleIndex method for handle /api/index route
 func (s *APIServer) handleIndex() http.HandlerFunc {
 	// Optional struct
 	type request struct{}