Files
Govor/docs/README.md

42 lines
5.7 KiB
Markdown

# Govor.API — обзор
Govor — мессенджер на ASP.NET Core и .NET MAUI. Эта документация описывает сервер Govor.API и его контракт с клиентом. Стек сервера: .NET 10, EF Core, PostgreSQL, JWT, SignalR, Firebase и локальное хранилище файлов.
## Что реализовано
Изменения рабочей копии сервера описаны в [исправлениях](server-fixes.md), включая [API прочтения](endpoints/message-read.md). Страницы со ссылками на commit `4603be9` описывают исходную версию до этих исправлений.
| Область | Состояние по коду |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Регистрация и вход | Регистрация по приглашению, BCrypt, открытие сессии и пара токенов |
| Сессии | Список, отзыв одной или всех сессий, обновление токенов |
| Друзья | Поиск, списки, отправка/принятие/отклонение заявок через SignalR |
| Личные чаты | Создание между друзьями, история, отправка и редактирование |
| Прочтение и удаление | HTTP/SignalR, видимые сообщения/граница/весь чат, квитанции и счётчики; удаление с проверкой прав |
| Реакции | [HTTP/SignalR, базовые эмодзи, общие паки картинок/GIF, административный API и выбор разрешённых реакций канала](endpoints/reactions.md) |
| Профиль | Описание, аватар, загрузка профиля и события изменений |
| Присутствие | События подключения/отключения; исправлены зависимости HTTP status |
| Медиа и push | Доступ к вложениям, привязка FCM к сессии, очередь и повторные попытки |
| Группы и каналы | [Публичный поиск, приватные приглашения, владелец/админы/участники, баны, модерация и обязательный канал](groups.md) |
| Шифрование | Есть хранение публичных ключей, но готового E2EE нет |
## Как читать
Начните с «Запуск и конфигурация» и «Аутентификация». Для чатов используйте HTTP для истории и SignalR для команд и событий. Раздел «Диагностика» описывает ограничения, которые нельзя считать рабочими гарантиями API.
Имена `userId`, `friendId`, `chatId` обозначают разные сущности. В сообщениях личного чата `recipientId` — ID записи PrivateChat, а не ID собеседника.
## Границы готовности
Документация новых групп и реакций описывает рабочую серверную копию с исправлениями доступа. Проверки HTTP/JWT, SQL и прав выполняются автоматическими тестами; реальная доставка на устройства и производственное развёртывание требуют отдельной проверки. Страницы с commit `4603be9` фиксируют старую диагностику и не описывают все текущие исправления.
Эффект стекла относится к MAUI-интерфейсу. API передаёт данные и события; производительность размытия, контрастность и анимации нужно проверять отдельно на устройствах.
Регистрация сейчас требует код приглашения. Обещание отключить приглашения после релиза является продуктовым планом, а не поведением текущего кода.
***
Проверено по исходникам на 03.10.2026, commit `4603be9`. Описано текущее поведение; успешная сборка не означает проверку работающего сервера.
Источник: [Govor.API/Program.cs](https://github.com/Govor-team/Govor/blob/4603be9f714135e0af72d505d17f3d1709834bea/Govor.API/Program.cs).