models/user.go - master - Soldier327/README_and_API

models/user.go
72 строки3 KB
Soldier327
create: todo.go, user.go, Readme.md, swagger.json, todo.go, user.go
11 май 2026, 16:35
11 май 2026, 16:35f9e6266
package models

import "time"

// User представляет пользователя в системе
type User struct {
	// ID уникальный идентификатор пользователя
	// @example 1
	// @readonly
	ID int `json:"id" example:"1"`
	
	// Email электронная почта пользователя
	// @example "john.doe@example.com"
	Email string `json:"email" example:"john.doe@example.com"`
	
	// Name полное имя пользователя
	// @example "John Doe"
	Name string `json:"name" example:"John Doe"`
	
	// CreatedAt дата и время регистрации пользователя
	// @example "2024-01-15T10:30:00Z"
	// @readonly
	CreatedAt time.Time `json:"created_at" example:"2024-01-15T10:30:00Z"`
}

// CreateUserRequest представляет запрос на создание нового пользователя
type CreateUserRequest struct {
	// Email электронная почта пользователя (обязательное поле)
	// Required: true
	// @example "john.doe@example.com"
	Email string `json:"email" validate:"required,email" example:"john.doe@example.com"`
	
	// Name полное имя пользователя (обязательное поле, максимум 100 символов)
	// Required: true
	// Max length: 100
	// @example "John Doe"
	Name string `json:"name" validate:"required,max=100" example:"John Doe"`
}

// UpdateUserRequest представляет запрос на обновление пользователя
// Все поля опциональны - будут обновлены только переданные
type UpdateUserRequest struct {
	// Email новый email пользователя (опционально)
	// @example "john.updated@example.com"
	Email *string `json:"email,omitempty" validate:"omitempty,email" example:"john.updated@example.com"`
	
	// Name новое имя пользователя (опционально, максимум 100 символов)
	// Max length: 100
	// @example "John Updated Doe"
	Name *string `json:"name,omitempty" validate:"omitempty,max=100" example:"John Updated Doe"`
}

// ErrorResponse представляет ответ с ошибкой
type ErrorResponse struct {
	// Error код или тип ошибки
	// @example "VALIDATION_ERROR"
	Error string `json:"error" example:"VALIDATION_ERROR"`
	
	// Message человекочитаемое сообщение об ошибке
	// @example "Email field is required"
	Message string `json:"message" example:"Email field is required"`
}

// SuccessResponse представляет успешный ответ API
type SuccessResponse struct {
	// Success флаг успешности операции
	// @example true
	Success bool `json:"success" example:"true"`
	
	// Data данные ответа (может быть любым типом)
	Data interface{} `json:"data,omitempty"`
}