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

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

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

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

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

ВидЭлемента: SoapСервис
ОбластьВидимости: ВПодсистеме
Имя: СервисМагазина
Ид: 20658364-7777-4b14-9423-ec212de5be72

Ид​

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

ВидЭлемента: SoapСервис
ОбластьВидимости: ВПодсистеме
Имя: СервисМагазина
Ид: 20658364-7777-4b14-9423-ec212de5be72

Импорт​

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

ВидЭлемента: SoapСервис
ОбластьВидимости: ВПодсистеме
Имя: СервисМагазина
Ид: 20658364-7777-4b14-9423-ec212de5be72
Импорт:
    - Главная
    - Настройки::НовыйПакет

Имя​

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

ВидЭлемента: SoapСервис
ОбластьВидимости: ВПодсистеме
Имя: СервисМагазина
Ид: 20658364-7777-4b14-9423-ec212de5be72

ИмяСервиса​

Строка. Имя сервиса. Атрибут name WSDL-описания сервиса (definitions.name). Если не указан, то используется имя элемента проекта. Пример YAML-файла:

ВидЭлемента: SoapСервис
Ид: 20658364-7777-4b14-9423-ec212de5be72
Имя: СервисМагазина
ОбластьВидимости: ВПодсистеме
ПространствоИменСервиса: https://mycustomshop.ru
ИмяСервиса: ShopService

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

Содержит настройки прав доступа к сервису. Если не указан, используется значение РазрешеноАдминистраторам. Пример YAML-файла:

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

КорневойUrl​

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

ВидЭлемента: SoapСервис
Ид: 20658364-7777-4b14-9423-ec212de5be72
Имя: СервисМагазина
ОбластьВидимости: ВПодсистеме
ПространствоИменСервиса: https://mycustomshop.ru
КорневойUrl: /shopservice

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

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

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

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

ВидЭлемента: SoapСервис
ОбластьВидимости: ВПодсистеме
Имя: СервисМагазина
Ид: 20658364-7777-4b14-9423-ec212de5be72

Обработчики​

Описание операций, которые предоставляет SOAP-сервис. Пример YAML-файла:

ВидЭлемента: SoapСервис
Ид: 20658364-7777-4b14-9423-ec212de5be72
Имя: СервисМагазина
ОбластьВидимости: ВПодсистеме
ПространствоИменСервиса: https://mycustomshop.ru
ИмяСервиса: ShopService
КорневойUrl: /shopservice
Обработчики:
    -
        Имя: AddToCart
        Метод: ДобавитьВКорзину
        Ошибки:
            - СервисМагазина.MyCustomException

Имя​

Строка. Имя операции сервиса. Пример YAML-файла:

Обработчики:
    -
        Имя: AddToCart
        Метод: ДобавитьВКорзину
        Ошибки:
            - СервисМагазина.MyCustomException

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

Содержит настройки прав доступа для вызова конкретной операции сервиса. Если не указан, то берется значение из группы свойств КонтрольДоступа, заданной для всего SOAP-сервиса. Пример YAML-файла:

Обработчики:
    -
        Имя: AddToCart
        Метод: ДобавитьВКорзину
        Ошибки:
            - СервисМагазина.MyCustomException
        КонтрольДоступа:
            Разрешения:
                Вызов: РазрешеноАутентифицированным

Метод​

Строка. Имя метода в модуле элемента проекта, который реализует операцию SOAP-сервиса. Пример YAML-файла:

Обработчики:
    -
        Имя: AddToCart
        Метод: ДобавитьВКорзину
        Ошибки:
            - СервисМагазина.MyCustomException

Ошибки​

Коллекция<Тип>. Список типов исключений, которые может выбрасывать метод. Если указанный тип не является исключением — будет ошибка проверки проекта. «1С:Шина» накладывает ограничения на типы исключений. Пример YAML-файла:

Обработчики:
    -
        Имя: AddToCart
        Метод: ДобавитьВКорзину
        Ошибки:
            - СервисМагазина.MyCustomException

Ошибки​

Коллекция<Тип>. Типы исключений, описывающих ошибки SOAP-сервиса. Могут быть переопределены для конкретной операции через свойство обработчика Ошибки.

«1С:Шина» формирует WSDL-контракт (секция faults):

  • из данного свойства;
  • из списков типов, указанных в свойстве Ошибки всех обработчиков.

«1С:Шина» накладывает ограничения на типы исключений. Пример YAML-файла:

ВидЭлемента: SoapСервис
Ид: 20658364-7777-4b14-9423-ec212de5be72
Имя: СервисМагазина
ОбластьВидимости: ВПодсистеме
ПространствоИменСервиса: https://mycustomshop.ru
Ошибки:
    - СервисМагазина.MyGeneralCustomException

ПространствоИменСервиса​

Строка. Пространство имен, в котором описан сервис. Атрибут targetNamespace WSDL-описания сервиса (definitions.targetNamespace). Пример YAML-файла:

ВидЭлемента: SoapСервис
Ид: 20658364-7777-4b14-9423-ec212de5be72
Имя: СервисМагазина
ОбластьВидимости: ВПодсистеме
ПространствоИменСервиса: https://mycustomshop.ru
Последнее обновление