-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Dynamically register /v3/api-docs request mapping, prepare (optional)…
… YAML support
- Loading branch information
Showing
10 changed files
with
212 additions
and
121 deletions.
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
.../src/main/java/de/qaware/openapigeneratorforspring/common/supplier/OpenApiYamlMapper.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /*- | ||
| * #%L | ||
| * OpenAPI Generator for Spring Boot :: API | ||
| * %% | ||
| * Copyright (C) 2020 QAware GmbH | ||
| * %% | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * #L% | ||
| */ | ||
|
|
||
| package de.qaware.openapigeneratorforspring.common.supplier; | ||
|
|
||
| import de.qaware.openapigeneratorforspring.model.OpenApi; | ||
|
|
||
|
|
||
| @FunctionalInterface | ||
| public interface OpenApiYamlMapper { | ||
| String map(OpenApi openApi); | ||
| } |
50 changes: 0 additions & 50 deletions
50
...mon/src/main/java/de/qaware/openapigeneratorforspring/common/AbstractOpenApiResource.java
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
...ing-web/src/main/java/de/qaware/openapigeneratorforspring/common/web/OpenApiResource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /*- | ||
| * #%L | ||
| * OpenAPI Generator for Spring Boot :: Common | ||
| * %% | ||
| * Copyright (C) 2020 QAware GmbH | ||
| * %% | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * #L% | ||
| */ | ||
|
|
||
| package de.qaware.openapigeneratorforspring.common.web; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import de.qaware.openapigeneratorforspring.common.OpenApiConfigurationProperties; | ||
| import de.qaware.openapigeneratorforspring.common.OpenApiGenerator; | ||
| import de.qaware.openapigeneratorforspring.common.supplier.OpenApiObjectMapperSupplier; | ||
| import de.qaware.openapigeneratorforspring.common.supplier.OpenApiYamlMapper; | ||
| import de.qaware.openapigeneratorforspring.model.OpenApi; | ||
| import io.swagger.v3.oas.annotations.Hidden; | ||
| import lombok.RequiredArgsConstructor; | ||
| import org.springframework.web.bind.annotation.ResponseBody; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| import java.lang.reflect.Method; | ||
| import java.util.Arrays; | ||
|
|
||
| import static de.qaware.openapigeneratorforspring.common.supplier.OpenApiObjectMapperSupplier.Purpose.OPEN_API_JSON; | ||
| import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE; | ||
|
|
||
| @RequiredArgsConstructor | ||
| @Hidden // exclude from OpenApi spec | ||
| @ResponseBody // all handler methods return response bodies, not view names | ||
| public class OpenApiResource { | ||
|
|
||
| private static final String[] YAML_MEDIA_TYPES = { | ||
| // see https://stackoverflow.com/q/332129 | ||
| // there seems to be no larger consensus what Accept: header tells we shall send YAML | ||
| "application/yaml", | ||
| "application/x-yaml", | ||
| "text/yaml", | ||
| "text/x-yaml", | ||
| "text/vnd.yaml", | ||
| }; | ||
|
|
||
| private final OpenApiGenerator openApiGenerator; | ||
| private final OpenApiConfigurationProperties properties; | ||
| private final OpenApiObjectMapperSupplier objectMapperSupplier; | ||
| @Nullable | ||
| private final OpenApiYamlMapper openApiYamlMapper; | ||
|
|
||
| public <T> void registerMapping(RequestMappingInfoBuilder<T> requestMappingInfoBuilder, | ||
| RequestMappingRegistrar<T> requestMappingRegistrar, | ||
| Object handler) { | ||
| requestMappingRegistrar.register( | ||
| requestMappingInfoBuilder.build(properties.getApiDocsPath(), APPLICATION_JSON_VALUE), | ||
| handler, | ||
| findMethod(handler.getClass(), "getOpenApiAsJson") | ||
| ); | ||
| requestMappingRegistrar.register( | ||
| requestMappingInfoBuilder.build(properties.getApiDocsPath(), YAML_MEDIA_TYPES), | ||
| handler, | ||
| findMethod(handler.getClass(), "getOpenApiAsYaml") | ||
| ); | ||
| } | ||
|
|
||
| private static Method findMethod(Class<?> clazz, String methodName) { | ||
| return Arrays.stream(clazz.getMethods()) | ||
| .filter(method -> method.getName().equals(methodName)) | ||
| .reduce((a, b) -> { | ||
| throw new IllegalStateException("Found more than one method with name " + methodName + " on " + clazz); | ||
| }) | ||
| .orElseThrow(() -> new IllegalStateException("No method found with name " + methodName + " on " + clazz)); | ||
| } | ||
|
|
||
| public String getOpenApiAsJson() throws JsonProcessingException { | ||
| OpenApi openApi = openApiGenerator.generateOpenApi(); | ||
| return objectMapperSupplier.get(OPEN_API_JSON).writeValueAsString(openApi); | ||
| } | ||
|
|
||
| public String getOpenApiAsYaml() throws OpenApiYamlNotSupportedException { | ||
| if (openApiYamlMapper == null) { | ||
| throw new OpenApiYamlNotSupportedException(); | ||
| } | ||
| OpenApi openApi = openApiGenerator.generateOpenApi(); | ||
| return openApiYamlMapper.map(openApi); | ||
| } | ||
|
|
||
| public static class OpenApiYamlNotSupportedException extends Exception { | ||
|
|
||
| } | ||
|
|
||
| public interface RequestMappingInfoBuilder<T> { | ||
| T build(String path, String... produces); | ||
| } | ||
|
|
||
| public interface RequestMappingRegistrar<T> { | ||
| void register(T mapping, Object handler, Method method); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.