Как заставить Swagger-UI использовать YAML / JSON вместо того, чтобы помещать аннотации на мой контроллер REST? - PullRequest
Новая
       20

Как заставить Swagger-UI использовать YAML / JSON вместо того, чтобы помещать аннотации на мой контроллер REST?

2 голосов
/ 12 марта 2019

Я привык добавлять аннотации на мои контроллеры REST для использования Swagger-UI. Тем не менее, я бы предпочел указать Swagger-UI на файл YAML, который описывает мой REST-контроллер. Пример того, что я хочу сделать, показан ниже. (Springfox / Swagger2)

DemoApplication.java 

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

SwaggerConfig.java

Обратите внимание, что я пытаюсь сказать Swagger о создании Docket на основе файла YAML, а не контроллера REST. 

import com.google.common.base.Predicate;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import static springfox.documentation.builders.PathSelectors.regex;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2).useDefaultResponseMessages(false)
                .select()
                .paths(paths())
                .build();
    }

    private Predicate<String> paths() {
        return regex("/swagger.yml");
    }
}

swagger.yml

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

swagger: "2.0"

paths:
  /animals:
      post:
        summary: Creates an animal.
        responses:
          '201':
            description: Created.

build.gradle 

plugins {
    id 'org.springframework.boot' version '2.1.3.RELEASE'
    id 'java'
}

apply plugin: 'io.spring.dependency-management'

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'

    implementation group: 'io.springfox', name: 'springfox-swagger2', version: '2.8.0'
    implementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.8.0'
}

Если это невозможно с файлом YAML, но можно использовать другой формат (например, JSON), смело отвечайте этим решением.

...