add end-points to readme

Author: sumaro2101

README.md

@@ -1,39 +1,105 @@
 # Title
+
 Данный шаблон был разработан для одной цели - облегчения и повышения качества
 выполненых тестовых заданий в рамках **FastAPI**.
 
 # Quick start
+
 Для тех кто уже знаком с реализацией и всеми деталями - могут приступить к установке.
+
 ## Enviroments
+
 Необходимо заполнить **.env.sample** и в последствии перемеиновать его в **.env**
+
 ```python
 # .env.sample
 POSTGRES_PASSWORD=password # Пароль от базы данных (Настройка)
 DB_PASSWORD=password # Пароль от базы данных (Использование)
 TEST_POSTGRES_PASSWORD=password # Пароль от тестовой базы данный (Настройка)
 TEST_DB_PASSWORD=password # Пароль от тестовой базы данных (Использование)
 ```
+
 ## Docker
+
 Шаблон находится под системой управления и контеризации - **Docker**.
 Если у вас нет Docker - вы можете установить его с официального сайта: [Docker](https://www.docker.com/get-started/)
+
 - Вам необходимо сделать "Билд"
+
 ```bash
 docker compose build
 ```
+
 - Вам необходимо запустить окружение
+
 ```bash
 docker compose up
 ```
-- После успешного запуска приложение будет доступно по адрессу: http://localhost:8080
-- Grafana: http://localhost:3000
-- Flower: http://localhost:5555
+
+- После успешного запуска приложение будет доступно по адрессу: <http://localhost:8080>
+- Grafana: <http://localhost:3000>
+- Flower: <http://localhost:5555>
 
 # View
+
 Обзор и детали данного шаблона
+
+## Users
+
+В данном шаблоне реализован CRUD для пользователя с помощью библиотеки
+fastapi-users
+
+### End-points
+
+`USERS`
+
+- <http://localhost:8080/api/v1/users/me> GET
+Получение текущего пользователя
+- <http://localhost:8080/api/v1/users/me> PATCH
+Изменение текущего пользователя
+- <http://localhost:8080/api/v1/users/{id}> GET
+Получение пользователя по ID Необходимо иметь права доступа уровня `admin`
+- <http://localhost:8080/api/v1/users/{id}> PATCH
+Изменение пользоватея по ID Необходимо иметь права доступа уровня `admin`
+- <http://localhost:8080/api/v1/users/{id}> DELETE
+Удаление пользоватея по ID Необходимо иметь права доступа уровня `admin`
+
+`AUTH`
+
+- <http://localhost:8080/api/v1/auth/jwt/login> POST
+Аутентификация в систему с последующим получением JWT для авторизации
+- <http://localhost:8080/api/v1/auth/jwt/logout> POST
+Вызод из системы
+- <http://localhost:8080/api/v1/auth/register> POST
+Регистрация нового пользователя
+- <http://localhost:8080/api/v1/auth/request-verify-token> POST
+Получение токена для верификации. `ВАЖНО` Читайте ниже, есть нюанс.
+- <http://localhost:8080/api/v1/auth/verify> POST
+Верификация пользователя по токену
+- <http://localhost:8080/api/v1/auth/forgot-password> POST
+Получение токена для изменения пароль. `ВАЖНО` Читайте ниже, есть нюанс.
+- <http://localhost:8080/api/v1/auth/reset-password> POST
+Изменения пароля посредством токена
+
+`ВАЖНО`
+
+- <http://localhost:8080/api/v1/auth/forgot-password> POST
+Должен осуществлять логику отправки токена по эмеилу либо другим способом.
+В данный момент отправка осуществляется через `консоль`.
+Для деталей смотрите миксин `api_v1/users/mixins/ActionUserManagerMixin`
+- <http://localhost:8080/api/v1/auth/forgot-password> POST
+Должен осуществлять логику отправки токена по эмеилу либо другим способом.
+В данный момент отправка осуществляется через `консоль`.
+Для деталей смотрите миксин `api_v1/users/mixins/ActionUserManagerMixin`
+
 ## Найболее используемые
+
 Найболее используемые конструкции с которыми приходится часто взаимодействовать.
+
 ### Registration Routers
+
 - В каждом приложений необходимо инициализировать router
+
 ```python
 # api/users/views.py
 from fastapi import APIRouter
@@ -44,7 +110,9 @@ router = APIRouter(
     tags=['Users'],
     )
 ```
+
 - Затем зарегистрировать роутер
+
 ```python
 # api_v1/routers.py
 from api_v1.users.views import router as users
@@ -58,11 +126,14 @@ def register_routers(app: FastAPI) -> None:
         prefix=settings.API_PREFIX,
     )
 ```
+
 После регистрации данные маршруты будут доступны.
 
 ### Registration Logs
+
 - Логи захватывают все исключения возникшие в системе
 и с помошью диспечиризации распределяется по нужным **file.log**
+
 ```python
 # app_includes/logs_errors.py
 from fastapi import FastAPI
@@ -86,7 +157,9 @@ def register_errors(app: FastAPI) -> None:
         )
         return JSONResponse(response)
 ```
+
 - Если вы пишете пользовательское исключение например:
+
 ```python
 from starlette.exceptions import HTTPException
 
@@ -95,11 +168,14 @@ class ValidationError(HTTPException):
 
 pass
 ```
+
 То вам нужно его зарегистрировать как было показанно выше,
 иначе logs не смогут выявить данное исключение и данные будут утеряны.
 
 ### Registration Middlaware
+
 - Для регистрации Middlaware вам нужно добавить его в функцию
+
 ```python
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi import FastAPI
@@ -119,10 +195,13 @@ def register_middlewares(app: FastAPI) -> None:
         allow_headers=['*'],
     )
 ```
+
 - При появлении новых middleware добавляйте их по порядку в эту функцию
 
 ### Celery
+
 - Для регистрации task вам нужно создать файл с именем **tasks.py** в вашем приложении:
+
 ```python
 # api_v1/users/tasks.py
 from config import celery_app
@@ -137,7 +216,9 @@ async def time_sleep_task():
     await asyncio.sleep(2.0)
     return 'Task is done'
 ```
+
 - Затем добавить этот файл в список пакетов Celery
+
 ```python
 # confin.celery.connection.py
 
@@ -146,14 +227,17 @@ app.conf.broker_url = settings.rabbit.broker_url
 # Регистрация до окружения где находится tasks.py
 app.autodiscover_tasks(packages=['api_v1.users'])
 ```
+
 - После этих действий ваша task будет зарегистрирована
 
 ### Test
+
 - Для тестирования у вас есть тестовая база данных, а так же
 уже инициализированный отдельный клиент.
 Cпособ реализации в **api_v1/tests/conftest.py**
 - Что бы написать тестовую функцию которой нужен доступ к API,
 вам нужно использовать fixture - client.
+
 > [!NOTE]
 > Для асинхронных тестов используйте **@pytest.mark.asyncio**
 
@@ -169,7 +253,9 @@ async def test_get_user_error(client: AsyncClient):
     )
     assert response.status_code == 400
 ```
+
 - Для запуска используйте команду
+
 ```bash
 pytest
-```
+```