Правила «хороших» URL

Для всех продуктов СБИС было введено единое правило формирования url-адресов. url-адреса должны иметь вид “https://<domain>/page/<pageId>”.

  • domain - доменное имя вашего сайта
  • pageId - уникальный идентификатор страницы, который указывается в pagex в поле id.

Подробнее про создание страниц с помощью pagex файлов можно прочитать в статье Создание новой страницы.

Правила формирования идентификатора страницы

Рассмотрим правила, которые нужно использовать для создания идентификатора страницы.

Регистр и язык

  • Все идентификаторы страниц должны быть в нижнем регистре.
  • Идентификаторы должны быть короткие, но если есть необходимость сделать идентификатор из нескольких слов, слова должны быть разделены через дефис.
  • Идентификаторы страниц не должны содержать русские буквы.
<!-- Хорошо -->
<page>
    <item id="tasks-in-work" title="Заголовок страницы"></item>
</page>
<!-- Плохо -->
<page>
    <item id="tasksInWork" title="Заголовок страницы"></item>
</page>

Название страницы

Идентификаторы страниц должны соответствовать тому названию, которое отображается в заголовке страницы в английской версии сайта.

<!-- Хорошо -->
<page>
    <item id="companies" title="Компании"></item>
</page>
<!-- Плохо -->
<page>
    <item id="contragents" title="Компании"></item>
</page>

Избегайте сокращенных названий. По URL пользователь должен понимать, о какой странице идет речь.

<!-- Хорошо -->
<page>
    <item id="documents-incoming" title="Входящие документы"></item>
</page>
<!-- Плохо -->
<page>
    <item id="incoming" title="Входящие документы"></item>
</page>

Группировка страниц в один логический блок

Страницы, которые относятся к одной логической группе(например, задачи, документы или настройки) должны иметь общий префикс в названии страницы.

<!-- Хорошо -->
<page>
    <item id="tasks-in-work" title="Задачи в работе"></item>
    <item id="tasks-controlled" title="Задачи на контроле"></item>
</page>
<!-- Плохо -->
<page>
    <item id="tasks-in-work" title="Задачи в работе"></item>
    <item id="controlled-tasks" title="Задачи на контроле"></item>
</page>


<!-- Хорошо -->
<page>
    <item id="settings-notice" title="Уведомления"></item>
    <item id="settings-interface" title="Интерфейс"></item>
</page>
<!-- Плохо -->
<page>
    <item id="notice-settings" title="Уведомления"></item>
    <item id="interface-settings" title="Интерфейс"></item>
</page>

Правила формирования идентификатора документа

Страницы документов должны открываться по адресу вида “https://<domain>/page/<pageId>/<cardId>”, где

  • domain - доменное имя вашего сайта.
  • pageId - уникальный идентификатор страницы, который указывается в pagex в поле id, например doc или dialog.
  • cardId - уникальный идентификатор карточки.

Чтобы переход осуществлялся по короткому адресу /doc/46c2f884, необходимо настроить перенаправление адреса в router.json. Подробнее читайте в статье "Работа с URL карточки документа"

На идентификатор карточки накладываются те же ограничения, что и на идентификатор страницы:

  • Идентификаторы должны быть в нижнем регистре.
  • Идентификаторы не должны содержать русские буквы.