.. _counter_provider_doc:

Общее описание
^^^^^^^^^^^^^^

**Сервис генерации уникального номера** позволяет создавать неповторяющиеся уникальные порядковые номера для сквозной 
нумерации файлов в сервисе формирования документов Типового ПО Витрины данных конфигурации Стандарт. 

В сервисе реализованы функции:

- долговременного хранения неограниченного списка счетчиков;
- атомарного изменения счетчика при параллельном использовании этой функции.

Основные функции модуля это: 

1. Создание и долговременное хранение неограниченного списка счетчиков;
2. Обработка запросов на предоставление следующего номера счетчика;
3. Создание резервной копии и восстановление из нее (бекапирование);
4. Миграция счетчиков;
5. Публикация данных о модуле.

Новый счетчик создается при первой попытке получения следующего номера счетчика (получен GET запрос ``/api/{service}/number/{counter}``).

Параметрами счетчика являются:

- Имя сервиса - переменная *service* в пути запроса;
- Имя счетчика - переменная *counter* в пути запроса;
- Стартовое значение - задается в настройке ``start-number`` модуля;
- Инкремент счетчика - задается в настройке ``increment-gap`` модуля.