Как начать работать с Swagger-UI

Question

Что такое Swagger-UI и в чем его польза?

Есть ли хорошие ресурсы для начала работы с Swagger-UI? Какие-нибудь хорошие учебники, блоги или книги?

Я также посещаю http://swagger.io/ но мне нужно больше информации.

пожалуйста, направь меня. Спасибо в Adv

Answer 1

Swagger UI - это инструмент, который берет файлы спецификаций Swagger, представляет их визуально и позволяет выполнять операции.

Swagger сам по себе является спецификацией для документирования и описания API REST. Спецификацию можно найти здесь - https://github.com/swagger-api/swagger-spec/. Репозиторий содержит саму спецификацию, схему json, примеры и т. Д. Основной README хранилища также указывает на дополнительные инструменты, включая библиотеки и интегрированные среды для создания ваших спецификаций.

Когда дело доходит до создания спецификации Swagger, вы можете использовать одну из платформ и интегрировать ее с существующим кодом для автоматической генерации такой документации.

Если у вас нет существующего приложения или вы хотите документировать его вручную, вы можете использовать инструмент Swagger-Editor или текстовый редактор по вашему выбору.

Answer 2

Зависимость от maven:

    <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger2</artifactId>
         <version>2.4.0</version>
    </dependency>  
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.4.0</version>
    </dependency>

================================================== ==========================

@Configuration
@EnableSwagger2   
    public class SwaggerConfig {

        private static final String SEARCH = "spring-rest-swagger";

        @Bean
        public Docket myApp() {
            return new Docket(DocumentationType.SWAGGER_2).groupName(SEARCH)
                    .apiInfo(apiInfo()).tags(new Tag(SEARCH, "spring-rest-swagger API"));
        }

        private ApiInfo apiInfo() {
            return new ApiInfoBuilder().title(SEARCH).build();
        }
    }

================================================== ============================

для справки используйте ссылку ниже:(пошаговое объяснение)

https://www.youtube.com/watch?v=xeYpiHLpme0&t=1s