Springfox

Статус сборки	Охват	Анализ кода
-------------
	### О проекте
Для получения более подробной информации посетите веб-сайт Springfox или http://springfox.github.io/springfox/.### Полезные ссылки

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

Начало работы

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

Для Maven

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

Для Gradle

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

Миграция с ранних версий

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

Замечание: Любые отзывы помогут сделать это лучше.

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

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

Замечание: Любые отзывы помогут сделать это лучше

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

Обычный Spring MVC

Замечание: Буду рад получить обратную связь, чтобы сделать этот опыт лучше

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

Авторское право 2015 года Марти Питт - @martypitt, Дилип Кришнан - @dilipkrish, Адриан Келли - @adrianbk,

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

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

Лицензия