Swagger Studio SaaS - Designer, 1 год

Swagger Studio SaaS - Designer - облачная платформа SmartBear для проектирования, документирования и управления API на протяжении их жизненного цикла. Лицензия Designer предоставляет пользователю права на создание и редактирование API и доменов, управление версиями и совместную работу над спецификациями. SaaS-модель обеспечивает доступ к Swagger Studio как к облачному сервису без развертывания собственной серверной инфраструктуры.

Ключевые возможности

• создание и редактирование API;
• поддержка спецификаций OpenAPI и AsyncAPI;
• централизованное хранение определений API;
• управление версиями API;
• сравнение и объединение версий;
• создание и редактирование Domains;
• повторное использование общих компонентов;
• совместная работа над API;
• управление доступом к API и доменам;
• интерактивная документация API;
• генерация клиентского и серверного кода;
• настройка Codegen;
• подключение интеграций;
• облачная модель SaaS.

Проектирование API

Swagger Studio предоставляет централизованную среду для проектирования публичных и частных API. Платформа поддерживает подход Design First, при котором структура API, операции и модели данных проектируются до реализации бизнес-логики.

Designer может создавать новые API с нуля, импортировать существующие определения, клонировать API и использовать готовые шаблоны.

OpenAPI и AsyncAPI

Swagger Studio поддерживает спецификации OpenAPI и AsyncAPI, что позволяет использовать платформу для проектирования REST API и событийно-ориентированных интерфейсов. Определения хранятся централизованно и могут совместно использоваться участниками команды.

Редактор Swagger Studio предоставляет подсветку синтаксиса, автодополнение, поиск и замену, сворачивание кода и предварительный просмотр интерактивной документации.

Управление версиями API

Swagger Studio позволяет создавать и поддерживать несколько версий API. Designer может добавлять и удалять версии, публиковать и снимать их с публикации, переименовывать, сравнивать и объединять изменения.

Версионирование помогает централизованно управлять развитием API и поддерживать актуальные спецификации для различных этапов разработки.

Domains и повторное использование компонентов

Для стандартизации API в Swagger Studio предусмотрены Domains — централизованные библиотеки общих компонентов. В них можно хранить модели данных, параметры, ответы и другие повторно используемые элементы и подключать их к различным определениям API.

Такой подход уменьшает дублирование и помогает использовать согласованные структуры и компоненты в нескольких API организации.

Совместная работа

Swagger Studio позволяет нескольким специалистам совместно работать над API и доменами. Для организации доступа используются роли, проекты и команды. Designer может получать права на необходимые ресурсы и участвовать в их создании и редактировании.

Для API также предусмотрены комментарии, позволяющие обсуждать спецификации непосредственно в общей рабочей среде.

Интерактивная документация

Swagger Studio автоматически формирует интерактивную документацию API на основе спецификации. Для OpenAPI доступна функция Try it out, с помощью которой можно отправлять запросы к API непосредственно из браузера и просматривать ответы, заголовки, продолжительность запроса и соответствующую команду cURL.

Документация обновляется вместе со спецификацией, что помогает поддерживать ее в соответствии с текущей версией API.

Генерация кода

Лицензия Designer предоставляет возможности генерации клиентского и серверного кода на основе определения API. Пользователь также может настраивать параметры Codegen в пределах предоставленных прав.

Генерация кода помогает использовать подготовленную спецификацию в качестве основы для дальнейшей реализации API и клиентских приложений.

Интеграции

Swagger Studio поддерживает интеграции с системами управления исходным кодом, IDE, инструментами сборки и платформами управления API. Среди поддерживаемых вариантов представлены GitLab, Azure DevOps, Bitbucket, IntelliJ IDEA, Visual Studio Code, Maven, Gradle, Amazon API Gateway, Azure API Management и другие инструменты.

Интеграции позволяют включать работу со спецификациями API в существующие процессы разработки и автоматизации.

SaaS - облачная версия

Swagger Studio SaaS работает как облачная платформа. API и связанные ресурсы хранятся в среде Swagger Studio и доступны авторизованным участникам организации в соответствии с назначенными ролями и правами.

Облачная модель не требует самостоятельной установки и обслуживания серверного экземпляра Swagger Studio.

Лицензия Designer

Designer - роль для специалистов, непосредственно работающих над проектированием API. Пользователь с такими правами может создавать и редактировать API и Domains, управлять версиями, генерировать клиентский и серверный код, настраивать Codegen и работать с интеграциями.

Количество пользователей Designer определяется количеством соответствующих лицензионных мест организации.

Designer и Consumer

Designer предоставляет права на создание и изменение API, тогда как Consumer ориентирован преимущественно на просмотр доступных API и Domains. При соответствующих настройках Consumer также может участвовать в обсуждении API через комментарии.

Назначение

Swagger Studio SaaS - Designer предоставляет разработчикам, API-архитекторам и другим специалистам облачную среду для проектирования и управления API. Платформа объединяет работу со спецификациями OpenAPI и AsyncAPI, управление версиями, повторное использование компонентов, совместную работу, документацию и генерацию кода.