Merge pull request 'haliullov_kamil_lab_3 fix' (#402) from haliullov_kamil_lab_3_fix into main
Reviewed-on: #402
This commit is contained in:
commit
679e3e1c99
2
haliullov_kamil_lab_3/.gitignore
vendored
Normal file
2
haliullov_kamil_lab_3/.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
/.venv
|
||||
/.idea
|
35
haliullov_kamil_lab_3/README.md
Normal file
35
haliullov_kamil_lab_3/README.md
Normal file
@ -0,0 +1,35 @@
|
||||
|
||||
# Лабораторная работа №3 - REST API, шлюз и синхронный обмен данными между микросервисами
|
||||
|
||||
## Задание
|
||||
|
||||
1. Создание двух микросервисов, которые реализуют операции CRUD для связанных сущностей.
|
||||
2. Реализация механизма синхронного обмена данными между микросервисами.
|
||||
3. Настройка шлюза на базе Nginx в качестве прозрачного прокси-сервера.
|
||||
|
||||
### Микросервисы:
|
||||
1. **theme_service** — сервис, который управляет информацией о темах.
|
||||
2. **book_service** — сервис, который обрабатывает данные о книгах, принадлежащих темам.
|
||||
|
||||
### Связь между микросервисами:
|
||||
- Один документ (theme) может иметь множество связанных предметов (book) (соотношение 1 ко многим).
|
||||
|
||||
## Как запустить проект:
|
||||
Для запуска приложения необходимо выполнить команду:
|
||||
`docker-compose up`
|
||||
|
||||
## Описание работы:
|
||||
|
||||
Для разработки микросервисов был выбран язык программирования Python.
|
||||
|
||||
### Синхронный обмен данными
|
||||
Сервис `theme_service` отправляет HTTP-запросы к `book_service` при выполнении определенных операций CRUD. Это позволяет получать актуальную информацию о книгах, связанных с конкретными темами.
|
||||
|
||||
### Docker Compose
|
||||
Конфигурационный файл `docker-compose.yml` представляет собой многоконтейнерное приложение, которое включает в себя три сервиса: `theme_service`, `book_service` и `nginx`. Функция маршрутизации возложена на сервер Nginx, который обрабатывает запросы и перенаправляет их на соответствующие микросервисы.
|
||||
|
||||
### Nginx
|
||||
Конфигурационный файл Nginx определяет настройки веб-сервера и обратного прокси, который управляет входящими запросами и направляет их на соответствующие сервисы.
|
||||
|
||||
## ВИДЕО
|
||||
https://disk.yandex.ru/i/cmY6ZnlH938Mpw
|
16
haliullov_kamil_lab_3/book_service/Dockerfile
Normal file
16
haliullov_kamil_lab_3/book_service/Dockerfile
Normal file
@ -0,0 +1,16 @@
|
||||
FROM python:latest
|
||||
|
||||
# Устанавливаю рабочую директорию внутри контейнера
|
||||
WORKDIR /app
|
||||
|
||||
# Копирую файл requirements.txt в контейнер
|
||||
COPY requirements.txt .
|
||||
|
||||
# Устанавливаю зависимости
|
||||
RUN pip install --no-cache-dir -r requirements.txt
|
||||
|
||||
# Копирую все файлы в контейнер
|
||||
COPY book_service/book_service.py .
|
||||
|
||||
# Команда для запуска Python-скрипта
|
||||
CMD ["python", "book_service.py"]
|
134
haliullov_kamil_lab_3/book_service/book_service.py
Normal file
134
haliullov_kamil_lab_3/book_service/book_service.py
Normal file
@ -0,0 +1,134 @@
|
||||
from flask import Flask, jsonify, request
|
||||
import requests
|
||||
from uuid import uuid4
|
||||
import uuid
|
||||
|
||||
|
||||
class Book:
|
||||
def __init__(self, title, year, author, uuid_: uuid, theme_id: uuid):
|
||||
if uuid_ is None:
|
||||
self.uuid_: uuid = uuid4()
|
||||
else:
|
||||
self.uuid_: uuid = uuid.UUID(uuid_)
|
||||
self.title: str = title
|
||||
self.year: int = year
|
||||
self.author: str = author
|
||||
self.theme_id: uuid = uuid.UUID(theme_id)
|
||||
|
||||
def to_dict(self):
|
||||
return {
|
||||
'title': self.title,
|
||||
'year': self.year,
|
||||
'author': self.author,
|
||||
'theme_id': self.theme_id,
|
||||
'uuid': self.uuid_
|
||||
}
|
||||
|
||||
def to_dict_for_themes(self):
|
||||
return {
|
||||
'title': self.title,
|
||||
'year': self.year,
|
||||
'author': self.author,
|
||||
'uuid': self.uuid_
|
||||
}
|
||||
|
||||
|
||||
|
||||
app = Flask(__name__)
|
||||
|
||||
books: list[Book] = [
|
||||
Book(title='Mac', year=1977, author= 'Jane', uuid_='89fa1e7a-7e88-445e-a4d8-6d4497ea8f19',
|
||||
theme_id='997aa4c5-ebb2-4794-ba81-e742f9f1fa30'),
|
||||
Book(title='Portrait', year=1989, uuid_='0351ee11-f11b-4d83-b2c8-1075b0c357dc', author= 'Mark',
|
||||
theme_id='694827e4-0f93-45a5-8f75-bad7ef2d21fe'),
|
||||
Book(title='Chamomile', uuid_='dfc17619-7690-47aa-ae8e-6a5068f8ddec', year=1977, author= 'Laura',
|
||||
theme_id='997aa4c5-ebb2-4794-ba81-e742f9f1fa30')
|
||||
]
|
||||
|
||||
themes_url = 'http://theme_service:20001/'
|
||||
|
||||
|
||||
def list_jsonify():
|
||||
return jsonify([book.to_dict() for book in books])
|
||||
|
||||
|
||||
# получить список книг
|
||||
@app.route('/', methods=['GET'])
|
||||
def get_all():
|
||||
return list_jsonify(), 200
|
||||
|
||||
|
||||
# получение списка книг по идентификатору темы (для theme_service)
|
||||
@app.route('/by-theme/<uuid:theme_uuid>', methods=['GET'])
|
||||
def get_by_theme_id(theme_uuid):
|
||||
return [book.to_dict_for_themes() for book in books if book.theme_id == theme_uuid], 200
|
||||
|
||||
|
||||
# получение книги по идентификатору
|
||||
@app.route('/<uuid:uuid_>', methods=['GET'])
|
||||
def get_one(uuid_):
|
||||
for book in books:
|
||||
if book.uuid_ == uuid_:
|
||||
return book.to_dict(), 200
|
||||
|
||||
return 'Книга с таким uuid не была найдена', 404
|
||||
|
||||
|
||||
|
||||
|
||||
# создание новой книги
|
||||
@app.route('/', methods=['POST'])
|
||||
def create():
|
||||
data = request.json
|
||||
title = data.get('title', None)
|
||||
year = data.get('year', None)
|
||||
author = data.get('author', None)
|
||||
theme_id = data.get('theme_id', None)
|
||||
# checking = requests.get(themes_url + f'/check/{theme_id}')
|
||||
# print(checking)
|
||||
# if checking.status_code == 200:
|
||||
new_book = Book(title, year,author, None, theme_id)
|
||||
books.append(new_book)
|
||||
return get_one(new_book.uuid_)
|
||||
# if checking.status_code == 404:
|
||||
# return 'Тема с таким uuid не существует', 404
|
||||
|
||||
return 'Неизвестная ошибка', 500
|
||||
|
||||
|
||||
# изменение книги по идентификатору
|
||||
@app.route('/<uuid:uuid_>', methods=['PUT'])
|
||||
def update_by_id(uuid_):
|
||||
data = request.json
|
||||
new_title = data.get('title', None)
|
||||
new_year = data.get('year', None)
|
||||
new_author = data.get('author', None)
|
||||
|
||||
for book in books:
|
||||
print(book.uuid_)
|
||||
|
||||
if book.uuid_ == uuid_:
|
||||
if new_title is not None:
|
||||
book.title = new_title
|
||||
if new_year is not None:
|
||||
book.year = new_year
|
||||
if new_author is not None:
|
||||
book.author= new_author
|
||||
return get_one(book.uuid_)
|
||||
|
||||
return 'Книга с таким uuid не была найдена', 404
|
||||
|
||||
|
||||
# удаление книги по идентификатору
|
||||
@app.route('/<uuid:uuid_>', methods=['DELETE'])
|
||||
def delete(uuid_):
|
||||
for book in books:
|
||||
if book.uuid_ == uuid_:
|
||||
books.remove(book)
|
||||
return 'Книга успешно удалена', 200
|
||||
|
||||
return 'Книга с таким uuid не была найдена', 404
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
app.run(host='0.0.0.0', port=20002, debug=True)
|
29
haliullov_kamil_lab_3/docker-compose.yml
Normal file
29
haliullov_kamil_lab_3/docker-compose.yml
Normal file
@ -0,0 +1,29 @@
|
||||
|
||||
services:
|
||||
|
||||
book_service:
|
||||
container_name: book_service
|
||||
build:
|
||||
context: .
|
||||
dockerfile: ./book_service/Dockerfile
|
||||
expose:
|
||||
- 20001
|
||||
|
||||
theme_service:
|
||||
container_name: theme_service
|
||||
build:
|
||||
context: .
|
||||
dockerfile: ./theme_service/Dockerfile
|
||||
expose:
|
||||
- 20002
|
||||
|
||||
nginx:
|
||||
image: nginx:latest
|
||||
ports:
|
||||
- "80:80"
|
||||
volumes:
|
||||
- ./nginx.conf:/etc/nginx/nginx.conf
|
||||
depends_on:
|
||||
- book_service
|
||||
- theme_service
|
||||
|
26
haliullov_kamil_lab_3/nginx.conf
Normal file
26
haliullov_kamil_lab_3/nginx.conf
Normal file
@ -0,0 +1,26 @@
|
||||
|
||||
events { worker_connections 1024; }
|
||||
|
||||
http {
|
||||
server {
|
||||
listen 80;
|
||||
listen [::]:80;
|
||||
server_name localhost;
|
||||
|
||||
location /theme_service/ {
|
||||
proxy_pass http://theme_service:20001/;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
|
||||
location /book_service/ {
|
||||
proxy_pass http://book_service:20002/;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
}
|
3
haliullov_kamil_lab_3/requirements.txt
Normal file
3
haliullov_kamil_lab_3/requirements.txt
Normal file
@ -0,0 +1,3 @@
|
||||
Flask==3.0.3
|
||||
requests==2.32.3
|
||||
|
16
haliullov_kamil_lab_3/theme_service/Dockerfile
Normal file
16
haliullov_kamil_lab_3/theme_service/Dockerfile
Normal file
@ -0,0 +1,16 @@
|
||||
FROM python:latest
|
||||
|
||||
# Устанавливаю рабочую директорию внутри контейнера
|
||||
WORKDIR /app
|
||||
|
||||
# Копирую файл requirements.txt в контейнер
|
||||
COPY requirements.txt .
|
||||
|
||||
# Устанавливаю зависимости
|
||||
RUN pip install --no-cache-dir -r requirements.txt
|
||||
|
||||
# Копирую все файлы в контейнер
|
||||
COPY theme_service/theme_service.py .
|
||||
|
||||
# Команда для запуска Python-скрипта
|
||||
CMD ["python", "theme_service.py"]
|
118
haliullov_kamil_lab_3/theme_service/theme_service.py
Normal file
118
haliullov_kamil_lab_3/theme_service/theme_service.py
Normal file
@ -0,0 +1,118 @@
|
||||
from flask import Flask, jsonify, request
|
||||
from uuid import uuid4
|
||||
import uuid
|
||||
import requests
|
||||
|
||||
|
||||
class Theme:
|
||||
def __init__(self, number, name, uuid_: uuid):
|
||||
if uuid_ is None:
|
||||
self.uuid_: uuid = uuid4()
|
||||
else:
|
||||
self.uuid_: uuid = uuid.UUID(uuid_)
|
||||
self.number: str = number
|
||||
self.name: str = name
|
||||
|
||||
def to_dict(self):
|
||||
return {
|
||||
"uuid": self.uuid_,
|
||||
"number": self.number,
|
||||
"name": self.name
|
||||
}
|
||||
|
||||
def to_dict_with_books(self, books: list):
|
||||
return {
|
||||
"uuid": self.uuid_,
|
||||
"number": self.number,
|
||||
"name": self.name,
|
||||
"books": books
|
||||
}
|
||||
|
||||
|
||||
app = Flask(__name__)
|
||||
|
||||
themes: list[Theme] = [
|
||||
Theme(name='Flowers', number='1', uuid_='997aa4c5-ebb2-4794-ba81-e742f9f1fa30'),
|
||||
Theme(name='Art', number='2', uuid_='694827e4-0f93-45a5-8f75-bad7ef2d21fe')
|
||||
]
|
||||
|
||||
books_url = 'http://book_service:20002/'
|
||||
|
||||
|
||||
def list_jsonify():
|
||||
return jsonify([theme.to_dict() for theme in themes])
|
||||
|
||||
|
||||
# получение списка всех тем
|
||||
@app.route('/', methods=['GET'])
|
||||
def get_all():
|
||||
return list_jsonify(), 200
|
||||
|
||||
|
||||
# получение темы по идентификатору
|
||||
@app.route('/<uuid:uuid_>', methods=['GET'])
|
||||
def get_one(uuid_):
|
||||
for theme in themes:
|
||||
if theme.uuid_ == uuid_:
|
||||
return theme.to_dict(), 200
|
||||
|
||||
return 'Тема с таким uuid не была найдена', 404
|
||||
|
||||
|
||||
# получение темы со списком книг по ней
|
||||
@app.route('/with-books/<uuid:uuid_>', methods=['GET'])
|
||||
def get_one_with_books(uuid_):
|
||||
for theme in themes:
|
||||
if theme.uuid_ == uuid_:
|
||||
response = requests.get(books_url + f'by-theme/{uuid_}')
|
||||
print(response.json())
|
||||
return theme.to_dict_with_books(response.json()), 200
|
||||
|
||||
return 'Тема с таким uuid не была найдена', 404
|
||||
|
||||
|
||||
# создание темы
|
||||
@app.route('/', methods=['POST'])
|
||||
def create():
|
||||
data = request.json
|
||||
number = data.get('number', None)
|
||||
name = data.get('name', None)
|
||||
if name is None or number is None:
|
||||
return 'Недостаточно полей для создания новой темы', 404
|
||||
|
||||
new_theme = Theme(number, name, None)
|
||||
themes.append(new_theme)
|
||||
return get_one(new_theme.uuid_)
|
||||
|
||||
|
||||
# изменение темы по идентификатору
|
||||
@app.route('/<uuid:uuid_>', methods=['PUT'])
|
||||
def update_by_id(uuid_):
|
||||
data = request.json
|
||||
new_number = data.get('number', None)
|
||||
new_name = data.get('name', None)
|
||||
|
||||
for theme in themes:
|
||||
if theme.uuid_ == uuid_:
|
||||
if new_number is not None:
|
||||
theme.number = new_number
|
||||
if new_name is not None:
|
||||
theme.name = new_name
|
||||
return get_one(theme.uuid_)
|
||||
|
||||
return 'Тема с таким uuid не была найдена', 404
|
||||
|
||||
|
||||
# удаление темы по идентификатору
|
||||
@app.route('/<uuid:uuid_>', methods=['DELETE'])
|
||||
def delete(uuid_):
|
||||
for theme in themes:
|
||||
if theme.uuid_ == uuid_:
|
||||
themes.remove(theme)
|
||||
return 'Тема успешно удалена', 200
|
||||
|
||||
return 'Тема с таким uuid не была найдена', 404
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
app.run(host='0.0.0.0', port=20001, debug=True)
|
Loading…
Reference in New Issue
Block a user