Свойства элемента проекта вида «HttpСервис»

В проекте HTTP-сервис имеет следующие свойства:

КорневойUrl

Строка. Корневой URL сервиса. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities

КонтрольДоступа

КонтрольДоступаHttpСервиса. Содержит настройки прав доступа. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities
КонтрольДоступа:
    Разрешения:
        Вызов: РазрешеноАутентифицированным

ШаблоныUrl

Коллекция ШаблонURL. Коллекция дочерних экземпляров ШаблонURL. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделки
    -
        Имя: ПолучитьСделку
        Шаблон: /{opportunity}
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделку

Имя

Строка. Имя шаблона. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделки

ЛюбойМетод

Строка. Метод по умолчанию. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        ЛюбойМетод: Sample_ДляВсех_ПоУмолчанию

КонтрольДоступа

Содержит настройки прав доступа для данного URL-шаблона. Пример YAML-файла:

ВидЭлемента: HttpСервис
Ид: a565661f-f458-465b-8f71-1f90cd490890
Имя: СделкиHttpСервис
ОбластьВидимости: ВПодсистеме
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        КонтрольДоступа:
            Разрешения:
                Вызов: РазрешеноАутентифицированным
        Шаблон: /
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделки

Методы

Коллекция дочерних экземпляров HTTPМетод. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделки

Обработчик

Строка. Имя метода-обработчика в модуле HTTP-сервиса. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделки

Метод

Строка. Тип метода. Соответствует HTTP Verb (GET, POST и т. п.). Если указано свойство ЛюбойМетод, то не используется. Во всех остальных случаях должен быть задан. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделки

КонтрольДоступа

Содержит настройки прав доступа для данного HTTP-метода URL-шаблона. Пример YAML-файла:

ВидЭлемента: HttpСервис
Ид: a565661f-f458-465b-8f71-1f90cd490890
Имя: СделкиHttpСервис
ОбластьВидимости: ВПодсистеме
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделки
                КонтрольДоступа:
                    Разрешения:
                        Вызов: РазрешеноАутентифицированным

Шаблон

Строка. Спецификация шаблона. Пример YAML-файла:

ВидЭлемента: HttpСервис
Id: a565661f-f458-465b-8f71-1f90cd490890
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
КорневойUrl: /opportunities
ШаблоныUrl:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        Методы:
            -
                Метод: GET
                Обработчик: ПолучитьСделки