springfox

Спрингфокс

Статус сборки	Покрытие	Анализ кода

Сонарное облако

О

Для получения дополнительной информации об этом проекте посетите веб-сайт Springfox или http://springfox.github.io/springfox/.

Полезные ссылки

• Справочная документация
• Репозиторий примеров
• Рекомендации по внесению взносов
• Основные участники
• Рекомендации по разработке и вкладу
• Журнал изменений
• Среда разработки
• Инструкции по выпуску

Начиная

Для новых проектов

Для Мавен

< dependency >
    < groupId >io.springfox</ groupId >
    < artifactId >springfox-boot-starter</ artifactId >
    < version >3.0.0</ version >
</ dependency >

Для Градла

  implementation " io.springfox:springfox-boot-starter:<version> " 

Миграция с более раннего снимка

Приложения Spring Boot

ПРИМЕЧАНИЕ. Хотелось бы получить обратную связь, чтобы сделать это лучше.

1. Удалить явные зависимости от springfox-swagger2
2. Удалите все аннотации @EnableSwagger2...
3. Добавьте зависимость springfox-boot-starter
4. Springfox 3.x удаляет зависимости от гуавы и других сторонних библиотек (еще не нулевая деп! зависит от плагина Spring и открытых библиотек API для аннотаций и моделей), поэтому, если вы использовали предикаты/функции гуавы, им необходимо будет перейти на функциональные интерфейсы Java 8. .

Миграция с существующей версии 2.x

Приложения Spring Boot

ПРИМЕЧАНИЕ. Хотелось бы получить обратную связь, чтобы сделать это лучше.

1. Удалить явные зависимости от springfox-swagger2
2. Удалите аннотации @EnableSwagger2
3. Добавьте зависимость springfox-boot-starter
4. Springfox 3.x удаляет зависимости от гуавы и других сторонних библиотек (еще не нулевая деп! зависит от плагина Spring и открытых библиотек API для аннотаций и моделей), поэтому, если вы использовали предикаты/функции гуавы, им необходимо будет перейти на функциональные интерфейсы Java 8.
5. Если вы используете WebMvc, но еще не используете аннотацию @EnableWebMvc , добавьте эту аннотацию.

Обычный весенний mvc

ПРИМЕЧАНИЕ. Хотелось бы получить обратную связь, чтобы сделать этот опыт лучше.

1. Удалить явные зависимости от springfox-swagger2
2. Добавьте @EnableOpenApi для открытого API (и @EnableSwagger2WebMvc или @EnableSwagger2WebFlux для более старых версий).
3. Добавлена ​​библиотека springfox-oas
4. Springfox 3.x удаляет зависимости от гуавы и других сторонних библиотек (еще не нулевая деп! зависит от плагина Spring и открытых библиотек API для аннотаций и моделей), поэтому, если вы использовали предикаты/функции гуавы, им необходимо будет перейти на функциональные интерфейсы Java 8.

Лицензия

Copyright 2015 Марти Питт – @martypitt, Дилип Кришнан – @dilipkrish, Адриан Келли – @adrianbk,

Лицензируется по лицензии Apache версии 2.0 («Лицензия»); вы не можете использовать этот файл, кроме как в соответствии с Лицензией. Вы можете получить копию Лицензии по адресу apache.org/licenses/LICENSE-2.0.

Если это не требуется действующим законодательством или не согласовано в письменной форме, программное обеспечение, распространяемое по Лицензии, распространяется на условиях «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ ИЛИ УСЛОВИЙ, явных или подразумеваемых. См. Лицензию для определения конкретного языка, регулирующего разрешения и ограничения в рамках Лицензии.

Лицензия