Перейти к основному содержимому

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

Ниже перечислены свойства HTTP-сервиса.

ВидЭлемента​

Вид элементов проекта (подробнее). Пример YAML-файла элемента проекта:

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

Ид​

Идентификатор элемента проекта. «1С:Шина» создает этот идентификатор автоматически. Пример YAML-файла:

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

Импорт​

Список импортированных пространств имен (подробнее). Пример YAML-файла:

ВидЭлемента: HttpСервис
ОбластьВидимости: ВПодсистеме
Имя: СделкиHttpСервис
Ид: a565661f-f458-465b-8f71-1f90cd490890
Импорт:
    - Главная
    - Настройки::НовыйПакет

Имя​

Имя элемента проекта или компонента. Пример YAML-файла:

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

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

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

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

КорневойUrl​

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

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

ОбластьВидимости​

Видимость элемента проекта (подробнее):

  • ВПодсистеме — элемент виден внутри одной подсистемы во всех пакетах. Значение по умолчанию.
  • ВПроекте — элемент виден во всех подсистемах одного проекта.
  • Глобально — элемент виден во всех подсистемах всех проектов.

Пример YAML-файла:

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

Шаблоны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
                Обработчик: ПолучитьСделки

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

Содержит настройки прав доступа для данного 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:
    -
        Имя: ПолучитьСделки
        Шаблон: /
        ЛюбойМетод: Sample\_ДляВсех\_ПоУмолчанию

Методы​

Коллекция дочерних экземпляров HTTPМетод. Пример 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
                Обработчик: ПолучитьСделки
                КонтрольДоступа:
                    Разрешения:
                        Вызов: РазрешеноАутентифицированным

Метод​

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

Шаблон​

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

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