Repolode
Предложить
swagger-api

swagger-api/swagger-core

Java-библиотека, которая генерирует спецификации OpenAPI по аннотациям кода и REST API на JAX-RS и поддерживает OpenAPI 3.x.

Открыть на GitHubСайт
Звёзды
7,535
Форки
2,255
Открытые issues
219
Последний коммит
позавчера

Что это?

Swagger Core — реализация спецификации OpenAPI на Java. Она считывает аннотации и классы REST-ресурсов в Java-приложении и формирует документ OpenAPI с описанием эндпоинтов, параметров, тел запросов и моделей ответов. Такие инструменты, как Swagger UI, могут отображать его в виде интерактивной документации API.

Проект предназначен для приложений на JAX-RS 2 и выпускает параллельные наборы артефактов для пространств имён javax и Jakarta. Начиная с версии 2.2.0 поддерживается OpenAPI 3.1, а ветка 1.x поддерживает OpenAPI 2.0. Для управления версиями отдельных модулей в сборках Maven и Gradle доступен артефакт BOM.

Репозиторий представляет собой многомодульную сборку Maven, для которой требуется Java 11 или новее. Примеры интеграции перенесены в отдельный репозиторий swagger-samples.

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

  • 01Генерирует документы OpenAPI 3.x по аннотациям Java и ресурсам JAX-RS.
  • 02Поддерживает артефакты для пространств имён javax и Jakarta.
  • 03Поддерживает OpenAPI 3.1 начиная с версии 2.2.0.
  • 04Предоставляет BOM для согласованного управления версиями зависимостей в Maven и Gradle.

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

  • Документирование REST API на Java: генерация спецификации OpenAPI по коду.
  • Добавление интерактивной документации API к сервису на JAX-RS.
  • Миграция Java-сервиса с javax на Jakarta с сохранением документации API.

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

  • Решение предназначено для Java и API JAX-RS 2, поэтому не подходит для других стеков.

Темы

#openapi#swagger#rest-api#java#api-documentation#jax-rs#hacktoberfest#open-source#openapi-specification#openapi3

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

Что такое swagger-core?
Java-библиотека, которая генерирует спецификации OpenAPI по аннотациям кода и REST API на JAX-RS и поддерживает OpenAPI 3.x. Swagger Core — реализация спецификации OpenAPI на Java. Она считывает аннотации и классы REST-ресурсов в Java-приложении и формирует документ OpenAPI с описанием эндпоинтов, параметров, тел запросов и моделей ответов. Такие инструменты, как Swagger UI, могут отображать его в виде интерактивной документации API.
swagger-core можно использовать бесплатно? Какая у него лицензия?
swagger-core распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
swagger-core всё ещё поддерживается?
Активно поддерживается. Последний коммит в swagger-core — 5 нояб. 2026 г..
Для чего можно использовать swagger-core?
Документирование REST API на Java: генерация спецификации OpenAPI по коду. Добавление интерактивной документации API к сервису на JAX-RS. Миграция Java-сервиса с javax на Jakarta с сохранением документации API.
Где скачать swagger-core?
Исходный код и инструкции по установке — на GitHub: https://github.com/swagger-api/swagger-core

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

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

scalar / scalar

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

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

Redocly / redoc

Инструмент с открытым исходным кодом для создания адаптивного трёхпанельного сайта со справочной документацией API на основе спецификаций OpenAPI, Swagger, AsyncAPI или GraphQL.

Инструменты разработчика#api-documentation#openapi#swagger
26 тыс.+10 за неделю2,4 тыс.TypeScriptMITАктивно поддерживаетсяОбновлён позавчера