6d3719ba71
Добавил документ для разработчиков (про сессии но не закончил) и исправил мекую ошибку с несопостовлениеминдексов
32 lines
2.6 KiB
Markdown
32 lines
2.6 KiB
Markdown
# Dev_Docs — оглавление
|
||
|
||
Этот набор документов сделан по текущему состоянию кода сервера (`/workspace/SHiNE-server`) и разбит по темам.
|
||
|
||
## Список документов
|
||
|
||
0. **API/01_Auth_and_Sessions_API.md**
|
||
API-глава для разработчиков: транспортный JSON-конверт, форматы запросов/ответов, создание и вход в сессию, `session_key`, `storagePwd`, подписи и совместимость версий.
|
||
|
||
1. **01_Connection_and_Sessions.md**
|
||
Процесс подключения к WebSocket, авторизация (двухшаговая), создание сессии, вход в существующую сессию, просмотр и закрытие сессий.
|
||
|
||
2. **02_Blockchain_Structure_and_Block_Types.md**
|
||
Архитектура блокчейна, форматы и типы блоков, что уже можно делать каждым типом блока.
|
||
|
||
3. **03_Addable_Blocks_Channels_Messages_Connections.md**
|
||
Какие блоки добавляются через `AddBlock`, как делать каналы/подписки/контакты/друзей/лайки/ответы, что уже есть и чего не хватает в API.
|
||
|
||
4. **04_Query_Design_for_Subscriptions_Counters_and_Sync.md**
|
||
Проектирование новых API-запросов: список подписок с общим/новым числом сообщений, список сообщений канала, граф ответов для сообщения, поток синхронизации online/offline.
|
||
|
||
5. **05_Open_Questions_and_TODO.md**
|
||
Список открытых вопросов, рисков и приоритетов для доработки сервера.
|
||
|
||
## Почему так разбито
|
||
|
||
- **Сначала протокол и сессии** — это входная точка клиента.
|
||
- **Потом блокчейн-слой** — какие данные вообще можно выразить блоками.
|
||
- **Потом прикладные функции (каналы/сообщения/связи)** — что реально можно сделать уже сейчас.
|
||
- **Потом проектирование отсутствующих запросов** — чтобы закрыть разрыв между текущим сервером и нужной функциональностью клиента.
|
||
- **В конце вопросы** — чтобы быстро согласовать спорные места.
|