OpenAPI

Этот раздел перенесён из документации Camunda 7 и в дальнейшем будет доработан с учётом особенностей OpenBPM Engine

REST API OpenBPM имеет описание OpenAPI, соответствующее Спецификации OpenAPI 3.0.2. OpenAPI — это стандартный, не зависящий от языка интерфейс к RESTful-API, который позволяет как людям, так и программам обнаруживать и понимать возможности сервиса без доступа к исходному коду, документации или анализа сетевого трафика.

Описание OpenAPI даёт возможности для:

  • Генерации клиента Генерация клиента на разных языках: обеспечивает гибкость для применения процессного движка на многих языках и возможность собственных реализаций поверх него.

  • Удобного начала работы Удобное начало работы: улучшает опыт начала работы, позволяя опробовать REST API, следуя документации и примерам.

Документация поставляется как один файл openapi.json, упакованный в jar-артефакт. Скачайте артефакт REST API OpenBPM, содержащий документацию OpenAPI, здесь. Выберите нужную версию и скачайте jar-файл.

В качестве альтернативы этот артефакт можно получить по следующим Maven-координатам:

<dependency>
  <groupId>io.openbpm.bpm</groupId>
  <artifactId>openbpm-engine-rest-openapi</artifactId>
  <version>${version}</version>
</dependency>

Генерация клиента

Чтобы сгенерировать клиент REST API на предпочитаемом вами языке на основе документации OpenAPI, вам понадобится библиотека-генератор клиентов, например OpenAPI Generator или любая другая библиотека, совместимая со Спецификацией OpenAPI версии 3.0.

Следуйте шагам из документации OpenAPI Generator: как установить инструмент и сгенерировать простой клиент на одном из поддерживаемых языков.

Удобное начало работы

Вместо генерации клиента вы можете воспользоваться одним из редакторов OpenAPI, чтобы поэкспериментировать с эндпоинтами REST API.

Перейдите в Swagger Editor и вставьте содержимое openapi.json в левую часть редактора. Запустите процессный движок с включёнными кросс-доменными запросами (CORS), и вы сможете выполнять запросы прямо из редактора.

Некоторые API-инструменты также поддерживают импорт эндпоинтов через загрузку документа OpenAPI. Например, пользователи Postman могут импортировать документацию OpenAPI и работать с REST-эндпоинтами из одного места.

Покрытие

В настоящее время описание охватывает все эндпоинты всех ресурсов, кроме следующих:

  • Case Definition

  • Case Execution

  • Case Instance

  • Historic Case Definition

  • Historic Case Instance

  • Historic Case Activity Instance

Лицензия и атрибуция

Эта документация была создана на базе материала "Camunda 7 Docs" от Camunda, находится под лицензией Creative Commons Attribution-ShareAlike 3.0 Unported License .

Оригинал документации: https://docs.camunda.org