Документування API

Створення документації API

Створення опису

  • Заходимо в InsCom, переходимо на сторінку Swagger (детально описано в розділі тестування API - Swagger).

  • У верхній частині сторінки є поле з адресою (типу http: // localhost: 88 / swagger / docs / v1), копіюємо цю адресу і вставляємо в адресний рядок браузера. Це призведе до формування файлу опису API в форматі json ПО ВСЬОМУ веб сервісів.

  • Зберігаємо файл.

Візуалізація опису

  • Відкриваємо сайт http://editor.swagger.io/

  • На сайті виконуємо наступні дії меню File-> import file і вибираємо файл створений на першому кроці.

  • Документація доступна в правій частині сторінки.

або

  • В меню сайту вибираємо Genarate Client.

  • Для формування документації необхідно вибрати такі пункти меню Html, Html2, Dynamic Html (різні варіанти).