RAML
Язык моделирования API-интерфейса RESTful (RAML) - это язык на основе YAML, который используется для описания интерфейсов RESTful API. RAML также позволяет подробно документировать RESTful API, поддерживает инструменты генератора документации для извлечения документации пользователя и последующего ее преобразования в визуальные форматы, например PDF, HTML и т. д.
Используйте действие RAML, чтобы получить доступ к API и выполнить вызовы API для сервисов, для которых интерфейсы API строятся с помощью RAML. Действие RAML поддерживает версию спецификации RAML 0.8.
Выполните следующие шаги, чтобы использовать действие RAML в своем процессе:
1. Щелкните и перетащите действие RAML из утилиты Разработка API на канву, наведите указатель на это действие и щелкните или дважды щелкните действие. Откроется окно RAML.
2. При необходимости измените поле Метка. По умолчанию наименование метки совпадает с наименованием действия.
3. В поле URL корневого файла введите URL-адрес для вызова ZIP-файла, содержащего корневой файл RAML и соответствующие зависимости.
4. В поле Имя корневого файла введите имя корневого файла RAML для вызова.
5. Щелкните Вызвать, чтобы получить все интерфейсы API, определенные в файле RAML.
Список Запрос API содержит список интерфейсов API, которые определены в файле RAML.
6. В списке Запрос API выберите интерфейс API.
В зависимости от выбранного интерфейса API, возможно, потребуется предоставить дополнительные сведения.
7. Нажмите кнопку Готово.
Схема вывода
Было ли это полезно?