Repolode
Предложить
springdoc

springdoc/springdoc-openapi

Создаёт документацию OpenAPI 3 и страницы Swagger UI или Scalar для приложений Spring Boot, анализируя контроллеры во время выполнения.

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

Открыть на GitHubСайт
Звёзды
3,746
Форки
612
Открытые issues
3
Последний коммит
20 часов назад

Что это?

springdoc-openapi — библиотека Java для приложений Spring Boot. Во время выполнения она анализирует контроллеры, конфигурацию, аннотации валидации и ограничения Bean Validation. Библиотека формирует описание OpenAPI 3 в форматах JSON и YAML, а также интерактивную страницу Swagger UI или Scalar. Чтобы начать работу, достаточно добавить одну зависимость starter — обязательная настройка не требуется.

Библиотека поддерживает Spring Web MVC и Spring WebFlux, в том числе функциональные эндпоинты, и интегрируется с Spring Security, OAuth 2, Spring Data REST, Spring HATEOAS и Actuator. Поддерживаются Kotlin, Groovy и Javadoc; кроме того, API можно предоставлять в виде инструментов для AI-агентов через MCP. Плагины Maven и Gradle позволяют генерировать описание во время сборки, также поддерживаются нативные образы GraalVM.

Проект рассчитан на Spring Boot 4.x и Java 17+. Ветка 2.x предназначена для Spring Boot 3, а версия 1.x больше не поддерживается в рамках open source.

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

  • 01Генерирует описания OpenAPI 3 в форматах JSON и YAML во время выполнения на основе кода Spring Boot.
  • 02Предоставляет страницы Swagger UI или Scalar для просмотра API.
  • 03Поддерживает Spring Web MVC, WebFlux и функциональные эндпоинты.
  • 04Интегрируется с Spring Security, OAuth 2, Spring Data REST и HATEOAS.
  • 05Читает аннотации Bean Validation, такие как @NotNull, @Min, @Max и @Size.
  • 06Предлагает плагины Maven и Gradle для генерации описания во время сборки.

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

  • Документирование REST API на Spring Boot без ручного написания файла OpenAPI.
  • Предоставление frontend-командам или внешним командам интерактивной страницы для проверки эндпоинтов.
  • Предоставление API на Spring в виде инструментов для AI-агентов через MCP.
  • Генерация файла OpenAPI во время сборки для создания клиентского кода или проверки контрактов.

В подборках

Вход, SSO и серверы идентификации

Темы

#java#spring-boot#openapi#swagger-ui#rest-api#api-documentation#json-format#kotlin#oauth2#openapi-spec

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

Что такое springdoc-openapi?
Создаёт документацию OpenAPI 3 и страницы Swagger UI или Scalar для приложений Spring Boot, анализируя контроллеры во время выполнения. springdoc-openapi — библиотека Java для приложений Spring Boot. Во время выполнения она анализирует контроллеры, конфигурацию, аннотации валидации и ограничения Bean Validation. Библиотека формирует описание OpenAPI 3 в форматах JSON и YAML, а также интерактивную страницу Swagger UI или Scalar. Чтобы начать работу, достаточно добавить одну зависимость starter — обязательная настройка не требуется.
springdoc-openapi можно использовать бесплатно? Какая у него лицензия?
springdoc-openapi распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
springdoc-openapi всё ещё поддерживается?
Активно поддерживается. Последний коммит в springdoc-openapi — 6 нояб. 2026 г..
Для чего можно использовать springdoc-openapi?
Документирование REST API на Spring Boot без ручного написания файла OpenAPI. Предоставление frontend-командам или внешним командам интерактивной страницы для проверки эндпоинтов. Предоставление API на Spring в виде инструментов для AI-агентов через MCP. Генерация файла OpenAPI во время сборки для создания клиентского кода или проверки контрактов.
Где скачать springdoc-openapi?
Исходный код и инструкции по установке — на GitHub: https://github.com/springdoc/springdoc-openapi

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

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

scalar / scalar

Набор инструментов с открытым исходным кодом для OpenAPI/Swagger: интерактивная справка по API, API-клиент с приоритетом работы офлайн и интеграции со многими веб-фреймворками.

Инструменты разработчика#openapi#swagger#api-documentation
16,4 тыс.+31 за неделю966TypeScriptMITОбновлён 11 часов назад