Repolode
swagger-api

swagger-api/swagger-ui

Swagger UI отображает в браузере интерактивную документацию API на основе спецификации OpenAPI/Swagger.

Open source альтернатива:Postman

Звёзды
29,039
Форки
9,251
Открытые issues
1,145
Последний коммит
4 дня назад

Что это?

Swagger UI создает наглядную интерактивную документацию API на основе спецификации OpenAPI (ранее Swagger). Разработчики и пользователи API могут просматривать эндпоинты, изучать схемы запросов и ответов, а также отправлять тестовые запросы прямо со страницы — без написания клиентского кода и даже если бэкенд еще не готов.

Проект распространяется в виде HTML-, JavaScript- и CSS-файлов в трех вариантах: npm-пакет swagger-ui — для одностраничных приложений со сборщиком; swagger-ui-dist — для серверов и приложений, которые не могут разрешать npm-зависимости; swagger-ui-react — в виде компонента React. В последних выпусках заявлена поддержка OpenAPI от версии 2.0 до 3.2.0.

Swagger UI работает в актуальных версиях Chrome, Safari, Firefox и Edge. Он поддерживает OAuth2-потоки, deep linking, настройку CORS и API плагинов для кастомизации.

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

  • 01Создает интерактивную документацию по спецификациям OpenAPI версий от 2.0 до 3.2.0.
  • 02Позволяет отправлять тестовые запросы к эндпоинтам прямо со страницы.
  • 03Поставляется в виде npm-пакетов для приложений со сборкой, независимой от зависимостей сборки dist и компонента React.
  • 04Поддерживает потоки авторизации OAuth2 и настройку CORS.
  • 05Предоставляет deep linking и API плагинов для настройки интерфейса.

Сценарии использования

  • Публикация документации API для внутренних или общедоступных REST-сервисов.
  • Возможность для команд фронтенда и мобильной разработки изучить API до завершения работы над бэкендом.
  • Встраивание интерактивной документации API в приложение React или на собственный сервер.

Быстрый старт

  1. 1

    Скачайте последнюю версию со страницы релизов GitHub

  2. 2

    Скопируйте содержимое папки /dist на сервер

Что важно знать

  • При установке npm-пакета через Scarf отправляются анонимизированные аналитические данные, если вы не откажетесь от этого.
  • Поддерживаются только последние версии Chrome, Safari, Firefox и Edge.

Темы

Частые вопросы

Что такое swagger-ui?
Swagger UI отображает в браузере интерактивную документацию API на основе спецификации OpenAPI/Swagger. Swagger UI создает наглядную интерактивную документацию API на основе спецификации OpenAPI (ранее Swagger). Разработчики и пользователи API могут просматривать эндпоинты, изучать схемы запросов и ответов, а также отправлять тестовые запросы прямо со страницы — без написания клиентского кода и даже если бэкенд еще не готов.
swagger-ui можно использовать бесплатно? Какая у него лицензия?
swagger-ui распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
swagger-ui всё ещё поддерживается?
Активно поддерживается. Последний коммит в swagger-ui — 16 окт. 2026 г..
Для чего можно использовать swagger-ui?
Публикация документации API для внутренних или общедоступных REST-сервисов. Возможность для команд фронтенда и мобильной разработки изучить API до завершения работы над бэкендом. Встраивание интерактивной документации API в приложение React или на собственный сервер.
Как установить swagger-ui?
Скачайте последнюю версию со страницы релизов GitHub Скопируйте содержимое папки /dist на сервер
Где скачать swagger-ui?
Исходный код и инструкции по установке — на GitHub: https://github.com/swagger-api/swagger-ui

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

Самостоятельно размещаемая open-source платформа для работы с PDF: редактирование, подпись, скрытие данных, конвертация и автоматизация в браузере, на компьютере или через API.

94,5 тыс.11,8 тыс.TypeScriptOtherОбновлён вчера