Описание метода client_lib.jobs()

Подготовка

1. С сайта SBCloud API выгружаем API в json-формате.
2. Открываем полученный файл в любом редакторе и удаляем методы, который не нужны на данный момент.

#!/bin/warning
Не удаляем json-схемы!

3. Переходим на сайт www.swdoc.org.

4. Последовательно выполняем:

.

• [1] - вставляем код из json-файла;
• [2] - ставим галочку;
• [3] - нажимаем Generate.

5. Сохраняем скомпилированный файл в pdf-формате, который содержит описание метода client_lib.jobs().

Конвертация в xml

Для конвертации pdf в xml можно использовать замечательный сервис - PDFTables

На выходе получаем структурированный xml-файл. В дальнейшем тэги надо декларировать, чтобы привязать к xsl-схеме и визуально оформить. Так же, можно заняться ручным переводом.

На самом деле, для автоматизации описания API, лучше использовать AsciiDoc и swagger2markup с дополнительными плагинами.

Альтернативный вариант

Как я уже писал выше, более правильный варинат - парсинг через swagger2 и далее конвертация в asciidoc. У swagger2 наблюдаются проблемы с jvm на windows.

Как варинат, я добавил распарсенный json силами asciidoc (client_lib.jobs(asciidoc).xml)