Главная Блог Статьи Конференции Портфолио Flash-point RSS  RU EN

Владимир Бондаренко

Специалист по web-технологиям
ПОСЛЕДНИЕ ЗАПИСИ
  •  Тьма за спиной – мобильный квест написанный Виталием Зыковым
  •  Автоматизация процессов в компании: объединение всей информационной среды в одной системе Mauris CRM (CMS + SalesForce + MailChimp + мобильное приложение)
  •  10 советов по созданию страницы своей компании в «Википедии»
  •  Сравниваем форматы для документирования RESTful API: WADL, Swagger, I/O Docs, API BluePrint, RAML, Google API Discovery, Apimatic

  • ОБЛАКО ТЕГОВ
    Ajax Apple Chrome cloud CMS ECM Flash-point Folium iPad iPhone Java Script jQuery mobile development MVC PHP Python RESTful API SDK SEO StarCraft Swagger Twitter блоги видео кодирование конференция обучение SEO оцифровка информации плагины презентация программирование развлечение скрипт советы сравнение технологии хостинг ЧПУ
    КОНТАКТЫ

    Skype: coolweb_ua

    twitter

    СЧЕТЧИК


    Сравниваем форматы для документирования RESTful API: WADL, Swagger, I/O Docs, API BluePrint, RAML, Google API Discovery, Apimatic

     

    Сравниваем форматы для документирования RESTful API: WADL, Swagger, I/O Docs, API BluePrint, RAML, Google API Discovery, Apimatic

    Перед тем как приступить к документированию RESTful API, нужно определиться, для какой цели вы хотите использовать документацию. Если вам нужна легкая и красивая документация - используйте RAML или  API BluePrint. Если основной задачей является генерация SDK - ваш выбор может пасть на Swagger.

    Я постарался выделить основные аспекты каждого формата RESTful API и изложить в компактной таблице:




    Генерация SDK 
     

    Размер кода

    Инструменты

    Графический редактор

    Легкая поддержка

    Документация


    WADL
     (2009)
    Формат: xml
     

    N/A

    Swagger (2012)
    Форматjson 


    I/O Docs
     (2006)
    Форматjson 
     


    N/A


    API BluePrint
     (2013)
    Форматbased on Markdown 
     


    RAML
     (2013)
    Форматjson 
     


    Google API Discovery
     (2014)
    Форматjson 
     

    N/A


    Apimatic
     (2014)
    Формат: json 
     


    Большая часть оценок в этой таблице субъективна и может ввести в заблуждение. Если коротко подытожить: выбирать нужно между API BluePrint, RAML и Swagger.

    Спросите, почему включил другие технологии? Они существуют - значит заслуживают места в этой таблице.

    Обычно формат документирования  RESTful API рассматривают вместе с сервисом для визуализации данных. Полный перечень актуальных сервисов для хранения RESTful API документации я описал в отдельной статье.

    Если для вас важным аспектом является возможность автоматической генерации документации, то рекомендую прочитать статью “автоматическая генерация SDK для RESTful API”.

    Перед тем как принимать окончательное решение в пользу Swagger - ознакомьтесь со статьей, в которой в которой изложены основные недостатки Swagger.


    Теги:  RESTful API, SDK, сравнение, технологии, Swagger

    Читать по теме:

     Почему не стоит использовать Swagger как сервис для документирования RESTful API?
     Автоматическая генерация SDK для RESTful API
     Перечень сервисов для документирования RESTful API
     Автоматизация процессов в компании: объединение всей информационной среды в одной системе Mauris CRM (CMS + SalesForce + MailChimp + мобильное приложение)

    loading

    Написать комментарий

    Имя:
    Почта (скрыта):
    Сайт:
    Текст: :) :( 0_o =-0 =-D 8-) :-(( TT >:o ]:->

    Использование любых материалов сайта возможно только при размещении активной и прямой ссылки на VBond.Kiev.ua.

    Главная | Блог | Статьи | Конференции | Портфолио | Flash-point | RSS

    developed by Bondarenko Volodymyr