Регистрация / Вход
Прислать материал

Разработка информационной системы документирования API веб-приложений

ФИО
Мурин Руслан Фаризович
Электронная почта
9cc4fdba8randexdev@gmail.com
Номинация
Информационные технологии
Институт
Институт информационных технологий и автоматизированных систем управления (ИТАСУ)
Кафедра
Информационные системы
ФИО научного руководителя
к.т.н. Стучилин Владимир Валерьевич
Академическая группа
ИС-12
Наименование тезиса
Разработка информационной системы документирования API веб-приложений
Тезис

Существует и разрабатывается большое количество веб-сервисов и приложений, взаимодействующих с другими веб-сервисами; некоторые из них даже базируются на этом, например приложение для просмотра данных по фильмам работает с базой данных фильмов, расположенной в Интернете. Это взаимодействие осуществляется с помощью веб-API - набора функций, предоставляемых разработчиком веб-сервиса. Чтобы другим разработчикам было удобно работать с API, его надо документировать - какие методы есть, какие параметры они принимают и что возвращают. 
Существует совсем небольшое количество сервисов, позволяющих документировать API, и многие из них требуют специальных знаний. Например, выучить специальный язык разметки.
Цель работы — уменьшить временные затраты и упростить создание документации.
Разрабатываемый сервис,позволяет документировать API, используя простой и понятный интерфейс.
Были разработаны алгоритмы быстрого сохранения документации в файл и считывания данных из файла, а также алгоритмы добавления  новых языков в существующую структуру документации.
Пользователю предоставляется возможность создавать документации для каждой версии API и поддерживать их раздельно друг от друга. К каждой документации можно добавлять дополнительные языки, чтобы можно было вести документацию на нескольких языках. На данный момент поддерживаются только публичные API, то есть те, которые доступны любому разработчику. У каждой опубликованной документации в сервисе есть своя постоянная ссылка, по которой можно получить доступ к этой документации. На странице документации предоставляется возможность оставлять комментарии и получать техподдержку от разработчика.

 

Научный руководитель: к.т.н. Стучилин Владимир Валерьевич