📝 Note API

Мини-сервис хранения заметок. Предназначен для практики написания автотестов с использованием BDD и паттернов проектирования.

---

📦 Состав проекта

• main.py — основной файл запуска FastAPI-приложения
• database.py — эмуляция хранения заметок в памяти
• models.py — описание моделей данных с использованием Pydantic
• requirements.txt — список зависимостей проекта

---

🚀 Инструкция по запуску проекта

1. Установите Python

Убедитесь, что у вас установлен Python 3.8+

python --version

Если Python не установлен: https://www.python.org/downloads/

---

2. Клонируйте проект

Клонируйте проект на свой компьютер:

git clone https://github.com/dipFireWorker/PatternsAndBDD.git
cd PatternsAndBDD

3. Установите зависимости

Создайте виртуальное окружение (по желанию):

python -m venv venv
source venv/bin/activate  # Linux/macOS
venv\Scripts\activate   # Windows

Установите библиотеки:

pip install -r requirements.txt

---

4. Запустите сервер

uvicorn main:app --reload

Теперь сервер доступен по адресу:

• Swagger UI: http://127.0.0.1:8000/docs

---

📚 Документация по API

🔹 GET /notes

Получение списка всех заметок
Ответ:

[
  {
    "id": 1,
    "title": "Пример",
    "content": "Это пример заметки"
  }
]

---

🔹 POST /notes

Создание новой заметки
Пример запроса:

{
  "title": "Новая заметка",
  "content": "Контент заметки"
}

Ответ:

{
  "id": 2,
  "title": "Новая заметка",
  "content": "Контент заметки"
}

---

🔹 GET /notes/{note_id}

Получение заметки по ID
Ответ:

{
  "id": 2,
  "title": "Новая заметка",
  "content": "Контент заметки"
}

Ошибки:

• 404 Not Found — если заметка не существует

---

🔹 PUT /notes/{note_id}

Обновление заметки по ID
Пример запроса:

{
  "title": "Обновленная заметка",
  "content": "Новый текст"
}

Ошибки:

• 404 Not Found — если заметка не существует

---

🔹 DELETE /notes/{note_id}

Удаление заметки по ID
Ответ:

{
  "detail": "Note deleted"
}

Ошибки:

• 404 Not Found — если заметка не существует