Инструмент для автоматической публикации документации на структуры данных
Аннотация
Выпускная квалификационная работа Воробьев Леонида Евгеньевича. Инструмент для автоматической публикации документации на структуры данных.
Объем работы: 27 страниц, 16 рисунков, 15 использованных источников.
Ключевые слова: база данных, API, RPC, REST, документация, backend, swagger, развертывание.
Цель работы - проектирование и реализация инструмента автоматической публикации документации на структуры данных в сервис Контур.API.
Методы работы: исследование возможности интеграции и реализации, аналитика существующих решений, проектирование, разработка и развертывание API.
Результат: исследованы возможности интеграции с сервисом документации API Контур.API. Среди нескольких вариантов реализации выбран оптимальный. Спроектированы, реализованы и развернуты 2 REST API приложения, предоставляющие ограниченные модели структур данных. В API подключена библиотека Swashbuckle, которая автоматически генерирует документацию. Через сервис ServiceDiscovery настроена интеграция с Контур.API, которая автоматически ссылается на актуальную документацию.
Объем работы: 27 страниц, 16 рисунков, 15 использованных источников.
Ключевые слова: база данных, API, RPC, REST, документация, backend, swagger, развертывание.
Цель работы - проектирование и реализация инструмента автоматической публикации документации на структуры данных в сервис Контур.API.
Методы работы: исследование возможности интеграции и реализации, аналитика существующих решений, проектирование, разработка и развертывание API.
Результат: исследованы возможности интеграции с сервисом документации API Контур.API. Среди нескольких вариантов реализации выбран оптимальный. Спроектированы, реализованы и развернуты 2 REST API приложения, предоставляющие ограниченные модели структур данных. В API подключена библиотека Swashbuckle, которая автоматически генерирует документацию. Через сервис ServiceDiscovery настроена интеграция с Контур.API, которая автоматически ссылается на актуальную документацию.