Giter Club home page Giter Club logo

demo's Introduction

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

Подготовка

  1. С сайта SBCloud API выгружаем API в json-формате.
  2. Открываем полученный файл в любом редакторе и удаляем методы, который не нужны на данный момент.
#!/bin/warning
Не удаляем json-схемы!
  1. Переходим на сайт www.swdoc.org.

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

Тыкаем.

  • [1] - вставляем код из json-файла;
  • [2] - ставим галочку;
  • [3] - нажимаем Generate.
  1. Сохраняем скомпилированный файл в 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)

demo's People

Contributors

andronovss avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.