Быстрый старт

Используйте сценарии быстрого старта для пошагового создания и настройки REST- и SOAP-сервисов.

Загрузка схемы сервиса

  1. Перейдите в раздел Ресурсы → schemas.

  2. Загрузите файл схемы сервиса:

  3. Если у вас нет готовой схемы:

    • для REST-сервиса используйте файлы примеров из папки Ресурсы → schemas → examples

    • для SOAP-сервиса используйте файлы примеров из папки Ресурсы → schemas → uniform-service

Создание REST-сервиса

В сценарии описывается создание публичного REST-сервиса на основе схемы pet.json из папки Ресурсы → schemas → examples.

  1. Перейдите в раздел "Сервисы и Клиенты".

  2. Нажмите кнопку Add Service.

  3. Выберите тип сервиса REST::OPENAPI::PUBLIC.

  4. Заполните обязательные поля:

    Поле Значение Описание

    General → Object ID

    pet-service

    Уникальный идентификатор сервиса, который используется в адресе его конечной точки.

    Main → OpenAPI schema

    pet.json

    Загруженная OpenAPI-схема, на основе которой платформа создает структуру REST-сервиса.

    Security → Authorization Type

    None

    Тип авторизации для доступа к сервису. Значение None означает, что сервис создается без проверки учетных данных и подходит для демонстрационного сценария.

  5. Нажмите кнопку Add, чтобы добавить сервис.

  6. Убедитесь, что сервис появился в разделе "Сервисы и Клиенты".

    После добавления сервиса его url становится доступен на странице http://localhost:8181/cxf, на ней отображается список всех сервисов, развернутых на платформе, и ссылки на их конечные точки.

Проверка REST-сервиса через Postman

Чтобы быстро узнать формат запроса перед тестированием, откройте загруженную схему сервиса через контекстное меню в Entaxy OpenAPI Editor.

Редактор помогает:

  • найти готовую структуру и пример JSON-тела для запроса;

  • изучить доступные эндпоинты, методы GET, POST, DELETE и параметры;

  • проверить типы данных и обязательные поля.

  1. Откройте Postman и создайте новый запрос.

  2. Выберите метод POST.

  3. Укажите URL сервиса:

    http://localhost:8181/cxf/pet-service/pet

  4. На вкладке Body выберите raw и формат JSON.

  5. Укажите тело запроса:

    {
  "id": 1001,
  "name": "Murzik",
  "photoUrls": [
    "https://example.com/images/murzik-1.jpg",
    "https://example.com/images/murzik-2.jpg"
  ],
  "status": "available",
  "category": {
    "id": 1,
    "name": "Cats"
  },
  "tags": [
    {
      "id": 101,
      "name": "domestic"
    },
    {
      "id": 102,
      "name": "vaccinated"
    }
  ]
}

  6. Нажмите Send.

  7. Убедитесь, что сервис возвращает ответ со статусом 200 OK.

Создание SOAP-сервиса

В сценарии описывается создание публичного SOAP-сервиса на основе WSDL-файла soap-passive.wsdl, из папки Ресурсы → schemas → uniform-service.

  1. Перейдите в раздел "Сервисы и Клиенты".

  2. Нажмите кнопку Add Service.

  3. Выберите тип сервиса SOAP::WSDL::PUBLIC.

  4. Заполните обязательные поля:

    Поле Значение Описание

    General → Object ID

    soap-service

    Уникальный идентификатор сервиса, который используется в адресе его конечной точки.

    Main → WSDL schema

    soap-passive.wsdl

    WSDL-файл с описанием интерфейса SOAP-сервиса.

    Security → Authorization Type

    None

    Тип авторизации для доступа к сервису. Значение None означает, что сервис создается без проверки учетных данных и подходит для демонстрационного сценария.

  5. Нажмите кнопку Add, чтобы добавить сервис.

  6. Убедитесь, что сервис появился в разделе "Сервисы и Клиенты".

После добавления сервиса его url становится доступен на странице http://localhost:8181/cxf, на ней отображается список всех сервисов, развернутых на платформе, и ссылки на их конечные точки.

Проверка SOAP-сервиса через Postman

  1. Откройте Postman и создайте новый запрос.

  2. Выберите метод POST.

  3. Укажите URL сервиса:

    http://localhost:8181/cxf/soap-service

  4. На вкладке Body выберите raw и формат XML.

  5. Укажите тело запроса:

    <?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ns="http://www.entaxy.ru/ExchangeTypes/1.0">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:packets>
         <ns:packet>
            <ns:id>7b9f3d1e-5a2c-4b8a-9d6e-1f3a5b7c9e1d</ns:id>
            <ns:sender>Test_System_1C</ns:sender>
            <ns:receiver>Test_System_CRM</ns:receiver>
            <ns:payload>Тестовые данные для проверки интеграции</ns:payload>
         </ns:packet>
      </ns:packets>
   </soapenv:Body>
</soapenv:Envelope>

  6. Нажмите Send.

  7. Убедитесь, что сервис возвращает ответ со статусом 200 OK.