-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1601 from ballerina-platform/bal-hateos-to-oas
[master] Ballerina HATEOAS mapping support for OAS code generation
- Loading branch information
Showing
22 changed files
with
1,410 additions
and
23 deletions.
There are no files selected for viewing
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
18 changes: 18 additions & 0 deletions
18
...na-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/constraint/Constants.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
25 changes: 25 additions & 0 deletions
25
...erina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/hateoas/Constants.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,25 @@ | ||
| /* | ||
| * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). | ||
| * | ||
| * WSO2 LLC. licenses this file to you 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. | ||
| */ | ||
|
|
||
| package io.ballerina.openapi.service.mapper.hateoas; | ||
|
|
||
| public class Constants { | ||
|
|
||
| public static final String OPENAPI_LINK_DEFAULT_REL = "_self"; | ||
| public static final String BALLERINA_LINKEDTO_KEYWORD = "linkedTo"; | ||
| } |
49 changes: 49 additions & 0 deletions
49
...ina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/hateoas/HateoasLink.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,49 @@ | ||
| /* | ||
| * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com). | ||
| * | ||
| * WSO2 LLC. licenses this file to you 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. | ||
| */ | ||
|
|
||
| package io.ballerina.openapi.service.mapper.hateoas; | ||
|
|
||
| public class HateoasLink { | ||
| private String resourceName; | ||
| private String relation; | ||
| private String resourceMethod; | ||
|
|
||
| public String getResourceName() { | ||
| return resourceName; | ||
| } | ||
|
|
||
| public void setResourceName(String resourceName) { | ||
| this.resourceName = resourceName; | ||
| } | ||
|
|
||
| public String getRel() { | ||
| return relation; | ||
| } | ||
|
|
||
| public void setRel(String relation) { | ||
| this.relation = relation; | ||
| } | ||
|
|
||
| public String getResourceMethod() { | ||
| return resourceMethod; | ||
| } | ||
|
|
||
| public void setResourceMethod(String resourceMethod) { | ||
| this.resourceMethod = resourceMethod; | ||
| } | ||
| } |
38 changes: 38 additions & 0 deletions
38
...a-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/hateoas/HateoasMapper.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,38 @@ | ||
| /* | ||
| * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). | ||
| * | ||
| * WSO2 LLC. licenses this file to you 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. | ||
| */ | ||
|
|
||
| package io.ballerina.openapi.service.mapper.hateoas; | ||
|
|
||
| import io.ballerina.compiler.syntax.tree.ServiceDeclarationNode; | ||
| import io.swagger.v3.oas.models.OpenAPI; | ||
|
|
||
| /** | ||
| * This {@link HateoasMapper} uses to set HATEOAS links into the OpenAPI context. | ||
| * | ||
| * @since 1.9.0 | ||
| */ | ||
| public interface HateoasMapper { | ||
|
|
||
| /** | ||
| * Sets HATEOAS links into the OpenAPI context. | ||
| * | ||
| * @param serviceNode Specific service declaration node | ||
| * @param openAPI Current OpenAPI context | ||
| */ | ||
| void setOpenApiLinks(ServiceDeclarationNode serviceNode, OpenAPI openAPI); | ||
| } |
196 changes: 196 additions & 0 deletions
196
...-openapi/src/main/java/io/ballerina/openapi/service/mapper/hateoas/HateoasMapperImpl.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,196 @@ | ||
| /* | ||
| * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). | ||
| * | ||
| * WSO2 LLC. licenses this file to you 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. | ||
| */ | ||
|
|
||
| package io.ballerina.openapi.service.mapper.hateoas; | ||
|
|
||
| import io.ballerina.compiler.syntax.tree.FunctionDefinitionNode; | ||
| import io.ballerina.compiler.syntax.tree.Node; | ||
| import io.ballerina.compiler.syntax.tree.ServiceDeclarationNode; | ||
| import io.ballerina.compiler.syntax.tree.SyntaxKind; | ||
| import io.ballerina.openapi.service.mapper.Constants; | ||
| import io.ballerina.openapi.service.mapper.utils.MapperCommonUtils; | ||
| import io.swagger.v3.oas.models.OpenAPI; | ||
| import io.swagger.v3.oas.models.PathItem; | ||
| import io.swagger.v3.oas.models.Paths; | ||
| import io.swagger.v3.oas.models.links.Link; | ||
| import io.swagger.v3.oas.models.responses.ApiResponse; | ||
| import io.swagger.v3.oas.models.responses.ApiResponses; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
|
|
||
| import static io.ballerina.openapi.service.mapper.hateoas.Constants.BALLERINA_LINKEDTO_KEYWORD; | ||
| import static io.ballerina.openapi.service.mapper.hateoas.Constants.OPENAPI_LINK_DEFAULT_REL; | ||
| import static io.ballerina.openapi.service.mapper.utils.MapperCommonUtils.generateRelativePath; | ||
| import static io.ballerina.openapi.service.mapper.utils.MapperCommonUtils.getResourceConfigAnnotation; | ||
| import static io.ballerina.openapi.service.mapper.utils.MapperCommonUtils.getValueForAnnotationFields; | ||
|
|
||
| /** | ||
| * This {@link HateoasMapperImpl} class represents the implementation of the {@link HateoasMapper}. | ||
| * | ||
| * @since 1.9.0 | ||
| */ | ||
| public class HateoasMapperImpl implements HateoasMapper { | ||
|
|
||
| @Override | ||
| public void setOpenApiLinks(ServiceDeclarationNode serviceNode, OpenAPI openAPI) { | ||
| Paths paths = openAPI.getPaths(); | ||
| Service hateoasService = extractHateoasMetaInfo(serviceNode); | ||
| for (Node node: serviceNode.members()) { | ||
| if (!node.kind().equals(SyntaxKind.RESOURCE_ACCESSOR_DEFINITION)) { | ||
| continue; | ||
| } | ||
| FunctionDefinitionNode resource = (FunctionDefinitionNode) node; | ||
| Optional<ApiResponses> responses = getApiResponsesForResource(resource, paths); | ||
| if (responses.isEmpty()) { | ||
| continue; | ||
| } | ||
| setOpenApiLinksInApiResponse(hateoasService, resource, responses.get()); | ||
| } | ||
| } | ||
|
|
||
| private Service extractHateoasMetaInfo(ServiceDeclarationNode serviceNode) { | ||
| Service service = new Service(); | ||
| for (Node child : serviceNode.children()) { | ||
| if (SyntaxKind.RESOURCE_ACCESSOR_DEFINITION.equals(child.kind())) { | ||
| FunctionDefinitionNode resourceFunction = (FunctionDefinitionNode) child; | ||
| String resourceMethod = resourceFunction.functionName().text(); | ||
| String operationId = MapperCommonUtils.getOperationId(resourceFunction); | ||
| Optional<String> resourceName = getResourceConfigAnnotation(resourceFunction) | ||
| .flatMap(resourceConfig -> getValueForAnnotationFields(resourceConfig, "name")); | ||
| if (resourceName.isEmpty()) { | ||
| continue; | ||
| } | ||
| String cleanedResourceName = resourceName.get().replaceAll("\"", ""); | ||
| Resource hateoasResource = new Resource(resourceMethod, operationId); | ||
| service.addResource(cleanedResourceName, hateoasResource); | ||
| } | ||
| } | ||
| return service; | ||
| } | ||
|
|
||
| private Optional<ApiResponses> getApiResponsesForResource(FunctionDefinitionNode resource, Paths paths) { | ||
| String resourcePath = MapperCommonUtils.unescapeIdentifier(generateRelativePath(resource)); | ||
| if (!paths.containsKey(resourcePath)) { | ||
| return Optional.empty(); | ||
| } | ||
| PathItem openApiResource = paths.get(resourcePath); | ||
| String httpMethod = resource.functionName().toString().trim(); | ||
| ApiResponses responses = null; | ||
| switch (httpMethod.trim().toUpperCase(Locale.ENGLISH)) { | ||
| case Constants.GET -> { | ||
| responses = openApiResource.getGet().getResponses(); | ||
| } | ||
| case Constants.PUT -> { | ||
| responses = openApiResource.getPut().getResponses(); | ||
| } | ||
| case Constants.POST -> { | ||
| responses = openApiResource.getPost().getResponses(); | ||
| } | ||
| case Constants.DELETE -> { | ||
| responses = openApiResource.getDelete().getResponses(); | ||
| } | ||
| case Constants.OPTIONS -> { | ||
| responses = openApiResource.getOptions().getResponses(); | ||
| } | ||
| case Constants.PATCH -> { | ||
| responses = openApiResource.getPatch().getResponses(); | ||
| } | ||
| case Constants.HEAD -> { | ||
| responses = openApiResource.getHead().getResponses(); | ||
| } | ||
| default -> { } | ||
| } | ||
| return Optional.ofNullable(responses); | ||
| } | ||
|
|
||
| private void setOpenApiLinksInApiResponse(Service hateoasService, FunctionDefinitionNode resource, | ||
| ApiResponses apiResponses) { | ||
| Map<String, Link> swaggerLinks = mapHateoasLinksToOpenApiLinks(hateoasService, resource); | ||
| if (swaggerLinks.isEmpty()) { | ||
| return; | ||
| } | ||
| for (Map.Entry<String, ApiResponse> entry : apiResponses.entrySet()) { | ||
| int statusCode = Integer.parseInt(entry.getKey()); | ||
| if (statusCode >= 200 && statusCode < 300) { | ||
| entry.getValue().setLinks(swaggerLinks); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private List<HateoasLink> getLinks(String linkedTo) { | ||
| List<HateoasLink> links = new ArrayList<>(); | ||
| String[] linkArray = linkedTo.replaceAll("[\\[\\]]", "").split("\\},\\s*"); | ||
| for (String linkString : linkArray) { | ||
| HateoasLink link = parseHateoasLink(linkString); | ||
| links.add(link); | ||
| } | ||
| return links; | ||
| } | ||
|
|
||
| private HateoasLink parseHateoasLink(String input) { | ||
| HateoasLink hateoasLink = new HateoasLink(); | ||
| HashMap<String, String> keyValueMap = new HashMap<>(); | ||
| String[] keyValuePairs = input.replaceAll("[{}]", "").split(",\\s*"); | ||
| for (String pair : keyValuePairs) { | ||
| String[] parts = pair.split(":\\s*"); | ||
| if (parts.length != 2) { | ||
| continue; | ||
| } | ||
| String key = parts[0].trim(); | ||
| String value = parts[1].replaceAll("\"", "").trim(); | ||
| keyValueMap.put(key, value); | ||
| } | ||
| hateoasLink.setResourceName(keyValueMap.get("name")); | ||
| hateoasLink.setRel(keyValueMap.getOrDefault("relation", OPENAPI_LINK_DEFAULT_REL)); | ||
| hateoasLink.setResourceMethod(keyValueMap.get("method")); | ||
| return hateoasLink; | ||
| } | ||
|
|
||
| private Map<String, Link> mapHateoasLinksToOpenApiLinks(Service hateoasService, | ||
| FunctionDefinitionNode resourceFunction) { | ||
| Optional<String> linkedTo = getResourceConfigAnnotation(resourceFunction) | ||
| .flatMap(resourceConfig -> getValueForAnnotationFields(resourceConfig, BALLERINA_LINKEDTO_KEYWORD)); | ||
| if (linkedTo.isEmpty()) { | ||
| return Collections.emptyMap(); | ||
| } | ||
| List<HateoasLink> links = getLinks(linkedTo.get()); | ||
| Map<String, Link> hateoasLinks = new HashMap<>(); | ||
| for (HateoasLink link : links) { | ||
| Optional<Resource> resource = hateoasService.getHateoasResourceMapping().entrySet().stream() | ||
| .filter(resources -> link.getResourceName().equals(resources.getKey())) | ||
| .findFirst() | ||
| .flatMap(hateoasResourceMapping -> hateoasResourceMapping.getValue().stream() | ||
| .filter(hateoasRes -> link.getResourceMethod().equals(hateoasRes.resourceMethod())) | ||
| .findFirst()); | ||
| if (resource.isEmpty()) { | ||
| continue; | ||
| } | ||
| Link openapiLink = new Link(); | ||
| String operationId = resource.get().operationId(); | ||
| openapiLink.setOperationId(operationId); | ||
| hateoasLinks.put(link.getRel(), openapiLink); | ||
| } | ||
| return hateoasLinks; | ||
| } | ||
| } |
Oops, something went wrong.