Как передать содержимое файла в аннотацию swagger @ExampleProperty? - PullRequest
Новая
       23

Как передать содержимое файла в аннотацию swagger @ExampleProperty?

0 голосов
/ 26 апреля 2019

Я использую swagger 3.0.0-Snapshot для создания документации для моего приложения Spring Boot.Мои зависимости maven 

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-spring-webmvc</artifactId>
            <version>3.0.0-SNAPSHOT</version>
        </dependency>

Мой класс конфигурации swagger настолько прост, насколько это возможно: 

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
    @Bean
    public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .select()
         .apis(RequestHandlerSelectors.basePackage("com.mycompany.cs"))
                .paths(PathSelectors.any())
                .build()
                .pathMapping("/")
                .useDefaultResponseMessages(false);
    }

И мой метод контроллера имеет следующую аннотацию: 

@ApiOperation(value = "Hello world", httpMethod = "POST")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "OK",
                    examples = @Example(value = @ExampleProperty(mediaType = "application/json",
                            value = exampleValue)))
    })

Он работает и показывает в поле «Пример значения» в пользовательском интерфейсе Swagger постоянную строку exampleValue, которая является частной статической строкой.

Вопрос состоит в том, как передать содержимое файла json, находящегося в папке ресурсов, в @ExamplePropertyзначение?

Я попытался прочитать содержимое файла в статическом блоке и передать его для инициализации конечной строки с ним, но затем компилятор говорит, что «значение атрибута должно быть постоянным».

Содержимоефайла json должен отображаться в поле примера в интерфейсе Swagger.

1 Ответ

0 голосов

Хорошая новость заключается в том, что Swagger использует Spring, и можно использовать силу DI.

Например, вы хотите добавить новую функциональность в ServiceModelToSwagger2MapperImpl. Создайте свой собственный компонент, который его расширяет, и отметьте его как основной. Spring автоматически подключит вашу реализацию абстрактного класса ServiceModelToSwagger2Mapper. 

@Component
@Primary
@Slf4j
public class ServiceModelToSwagger2MapperExtensionImpl extends ServiceModelToSwagger2MapperImpl {

Например, вы хотите, чтобы он прочитал содержимое файла и поместил его в поле примера: 

@Override
protected Map<String, Response> mapResponseMessages(Set<ResponseMessage> from) {
    Map<String, Response> responses = super.mapResponseMessages(from);
    responses.forEach((key, response)-> {
        Map<String, Object> examples = response.getExamples();
        examples.entrySet().forEach(example -> {
            Object exampleObject = example.getValue();
            if (exampleObject instanceof String) {
                String exampleValue = (String) exampleObject;
                if (exampleValue.startsWith("file:")) {
                    String fileContent = readFileContent(exampleValue);
                    example.setValue(fileContent);
                }
            }});
    });

    return responses;
}

private String readFileContent(String example) {
    String fileContent = "";
    try {
        String fileName = example.replace("file:", "");
        File resource = new ClassPathResource(fileName).getFile();
        if(resource.exists()) {
            fileContent
                    = new String(Files.readAllBytes(resource.toPath()));
        }
    } catch (
            IOException e) {
        log.error("Cannot read swagger documentation from file {}", example);
    }
    return fileContent;
}

А вот пример использования в вашем контроллере: 

@ApiResponses(value = {
        @ApiResponse(code = 200, message = "OK",
                examples = @Example(value = @ExampleProperty(mediaType = "application/vnd.siren+json",
                        value = "file:/data/controller-responses/reponse.json")))
})
...