Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.41 KB

msra-app-groups.md

File metadata and controls

28 lines (18 loc) · 1.41 KB

[app.groups.]

Таблица [app.groups.<path>] задаёт логическую структуру API и то, как функции будут разложены по generated package. Группы не выполняют запросы сами по себе, но определяют дерево классов и навигацию в клиенте.

Ключ Что делает Как влияет на поведение
description Описание группы Используется в generated docs, docstring-ах и в IDE-подсказках.

Что меняется

  • Путь группы определяет, в каком namespace окажется функция.
  • Группы строят дерево классов в generated client.
  • Это удобно, когда API логически делится на каталоги, геолокацию, рекламу, общие хелперы и т.п.

Пример

[app.groups.Catalog]
description="Каталог и товарные методы"

[app.groups.Catalog.Products]
description="Методы страниц товара"

Замечание по пути

Для групп действуют общие правила identity путей и quoted/unquoted-имен. Если нужен разбор этих правил, см. Пути и identity.