Описание проекта

Simple Service – это REST API-сервис, написанный на Go с использованием фреймворка Fiber и PostgreSQL. Сервис предоставляет базовый функционал для управления задачами.

Реализовано:

• Создание задач через API
• Валидация входных данных
• Логирование с использованием zap
• Хранение данных в PostgreSQL
• Подключение через pgxpool для эффективного управления соединениями

---

1️⃣ Подготовка окружения

1.1 Установка зависимостей

Перед запуском убедитесь, что у вас установлены:

• Go
• Docker
• DataGrip или аналогичное приложение
• Postman или Insomnia для тестирования API

1.2 Клонирование репозитория

git clone https://github.com/yourusername/simple-service.git
cd simple-service

---

2️⃣ Запуск PostgreSQL в Docker

2.1 Запуск контейнера

Создайте и запустите контейнер с PostgreSQL:

docker run --name postgres-db -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=admin -e POSTGRES_DB=simple_service -p 5432:5432 -d postgres:latest

Параметры:

• POSTGRES_USER=admin – имя пользователя БД
• POSTGRES_PASSWORD=admin – пароль
• POSTGRES_DB=simple_service – название базы
• -p 5432:5432 – проброс порта

2.2 Проверка работы БД

Подключитесь к PostgreSQL с помощью программы (DataGrip) и создайте там таблицу

---

3️⃣ Настройка проекта

3.1 Создание .env файла

Создайте .env файл и пропишите параметры:

LOG_LEVEL=info
POSTGRES_USER=admin
POSTGRES_PASSWORD=admin
POSTGRES_DB=simple_service
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
REST_LISTEN_ADDRESS=:8080
REST_TOKEN=your_secret_token

Также установите плагин в вашу IDLE. Я использую ее: https://github.com/Ashald/EnvFile

3.2 Применение миграций

Создайте таблицу tasks в базе данных:

CREATE TABLE tasks (
    id SERIAL PRIMARY KEY,
    title TEXT NOT NULL,
    description TEXT,
    status TEXT CHECK (status IN ('new', 'in_progress', 'done')) DEFAULT 'new',
    created_at TIMESTAMP DEFAULT now(),
    updated_at TIMESTAMP DEFAULT now()
);

---

4️⃣ Запуск сервиса

4.1 Локальный запуск

go run cmd/main.go

Сервис будет доступен по адресу http://localhost:8080

---

5️⃣ Тестирование API

5.1 Создание задачи

Запрос:

POST http://localhost:8080/v1/tasks
Content-Type: application/json
Authorization: Bearer your_secret_token

{
  "title": "New Feature",
  "description": "Develop new API endpoint"
}

Ответ:

{
  "status": "success",
  "data": {
    "task_id": 1
  }
}

---

6️⃣ Остановка и удаление контейнера

docker stop postgres-db && docker rm postgres-db

---

Дополнительная информация

• Файл docs/openapi.yaml содержит документацию API в формате OpenAPI 3.0
• Логирование ведётся через zap.Logger
• Переменные окружения загружаются через envconfig
• Соединение с PostgreSQL осуществляется через pgxpool

Сервис готов к работе.