Быстрый старт
В этом руководстве вы пройдёте путь от регистрации до создания первой архитектурной диаграммы. Это займёт около 5 минут.
1. Регистрация аккаунта
- Откройте страницу регистрации и нажмите Регистрация.
- Введите вашу электронную почту и нажмите Продолжить.
- Проверьте почту — на неё придёт код подтверждения.
- Введите код из письма и создайте пароль.
Требования к паролю
Пароль должен содержать не менее 8 символов, заглавные буквы и цифры.
- Нажмите Продолжить — аккаунт создан.
- Авторизуйтесь с вашим email и паролем — вы попадёте на главный экран.
2. Обзор интерфейса
После входа вы увидите доску. Она состоит из трёх частей:
| Область | Расположение | Назначение |
|---|---|---|
| Левая панель | Слева | Дерево систем: команды, папки, системы |
| Доска | По центру | Область для построения диаграммы |
| Правая панель | Справа | Детали выбранного элемента: описание, связи, API, обсуждения |
В нижней части доски находится панель инструментов с кнопками:
- Курсор — режим выделения элементов
- Рука — режим навигации по доске (перемещение, зум)
- Настройки — фильтрация по тегам, технологиям, доменам, версиям
- Добавить объект (+) — создание нового элемента на диаграмме
3. Создание системы
Система — это контейнер для вашей архитектурной диаграммы. Чтобы создать первую систему:
- В левой панели наведите курсор на многоточие рядом с вашей командой.
- Выберите Добавить систему.
- Введите название, например «Интернет-магазин».
- Нажмите Сохранить — система появится в дереве.
Кликните на систему в дереве, чтобы открыть её доску.
Папки
Вы можете организовать системы по папкам. Правый клик → Добавить папку.
4. Добавление объектов
Объекты — это элементы вашей архитектуры: сервисы, базы данных, очереди и другие компоненты.
- Нажмите на кнопку + в нижней панели инструментов.
- Выберите тип объекта из списка:
| Тип | Описание |
|---|---|
| Сервис | API-сервис (REST, gRPC, GraphQL и др.) |
| База данных | Хранилище данных (PostgreSQL, MongoDB, Redis и др.) |
| Очередь сообщений | Брокер сообщений (Kafka, RabbitMQ, NATS и др.) |
| Пользователь | Внешний пользователь или актор |
| Группа | Контейнер для группировки объектов |
| Рамка | Визуальная рамка / граница |
- Кликните на доску, чтобы разместить объект.
Для нашего примера добавьте три объекта:
- Сервис — назовите «API Gateway»
- Сервис — назовите «Order Service»
- База данных — назовите «Orders DB»
Чтобы переименовать объект, кликните на него и измените название в правой панели.
5. Соединение объектов связями
Связи показывают, как компоненты взаимодействуют друг с другом.
- Наведите курсор на объект — по краям появятся точки подключения (порты).
- Зажмите левую кнопку мыши на порте и перетащите линию к порту на другом объекте.
- Отпустите — связь между объектами создана.
Создайте две связи:
- API Gateway → Order Service
- Order Service → Orders DB
Чтобы посмотреть или изменить свойства связи, кликните на неё — детали откроются в правой панели во вкладке Связи.
6. Добавление контракта к объекту
Контракт описывает API* вашего сервиса: эндпоинты, методы, пути.
- Кликните на объект «Order Service».
- В правой панели перейдите на вкладку API.
- Нажмите Добавление API для создания контракта вручную.
- Заполните форму:
- Название API — например «Создание заказа»
- Тип — выберите протокол (например HTTP)
- Метод — POST
- Путь —
/api/v1/orders
- Нажмите Сохранить.
Контракт появится в списке API этого объекта.
7. Результат
Поздравляем! Вы создали свою первую архитектурную диаграмму в tevas.io:
- 3 объекта — API Gateway, Order Service, Orders DB
- 2 связи — показывают направление взаимодействия
- 1 контракт — описывает API эндпоинт сервиса
Что дальше?
- Словарь терминов — определения всех понятий
- Объекты — подробнее о типах объектов и их свойствах
- Связи и протоколы — доступные протоколы взаимодействия
- Контракты — импорт из OpenAPI, gRPC, GraphQL
- Команды — как пригласить коллег для совместной работы
*API (Application Programming Interface) — программный интерфейс приложения, набор правил взаимодействия между программными компонентами.