Skip to content

Create PUT/PATCH/POST methods for OpenApi #573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
May 21, 2024
Merged

Create PUT/PATCH/POST methods for OpenApi #573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5e83881
Create PUT/PATCH/POST methods for OpenApi
Yauhenikapl May 10, 2024
e39ac10
Fix styles and linter errors
Yauhenikapl May 10, 2024
a99b51a
Add CRUD tests of AspectModelOpenApiGenerator
Yauhenikapl May 13, 2024
7025fb2
Add CRUD functionality to Maven Plugin
Yauhenikapl May 14, 2024
b65d95c
Update docs for all CRUD methods for OpenAPI Specification.
Yauhenikapl May 14, 2024
8e8c855
Merge branch 'main' into 451-create-put-patch-post-in-openaPI-generatio
Yauhenikapl May 14, 2024
2079d77
Merge branch 'main' into 451-create-put-patch-post-in-openaPI-generatio
Yauhenikapl May 16, 2024
7782046
Update PR for need changes.
Yauhenikapl May 21, 2024
9a06b31
Fix ckeckStyle
Yauhenikapl May 21, 2024
96137fb
Fix MavenPlugin tests
Yauhenikapl May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 48 additions & 8 deletions ...main/java/org/eclipse/esmf/aspectmodel/generator/openapi/AspectModelOpenApiGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,19 @@ public class AspectModelOpenApiGenerator
private static final String FIELD_DESCRIPTION = "description";
private static final String FIELD_FILTER = "Filter";
private static final String FIELD_GET = "get";
private static final String FIELD_POST = "post";
private static final String FIELD_PUT = "put";
private static final String FIELD_PATCH = "patch";
private static final String FIELD_OBJECT = "object";
private static final String FIELD_OPERATION = "Operation";
private static final String FIELD_OPERATION_ID = "operationId";
private static final String FIELD_OPERATION_RESPONSE = "OperationResponse";
protected static final String FIELD_PAGING_SCHEMA = "PagingSchema";
private static final String FIELD_PARAMETERS = "parameters";
private static final String FIELD_POST = "post";
private static final String FIELD_PROPERTIES = "properties";
private static final String FIELD_RPC = "JsonRpc";
private static final String FIELD_REQUEST_BODIES = "requestBodies";
private static final String FIELD_REQUEST_BODY = "requestBody";
private static final String FIELD_REQUIRED = "required";
private static final String FIELD_RESPONSES = "responses";
private static final String FIELD_SCHEMA = "schema";
Expand Down Expand Up @@ -118,9 +121,9 @@ public OpenApiSchemaArtifact apply( final Aspect aspect, final OpenApiSchemaGene
final ObjectNode rootNode = getRootJsonNode( config.generateCommentForSeeAttributes() );
final String apiVersion = getApiVersion( aspect, config.useSemanticVersion() );

( (ObjectNode) rootNode.get( "info" ) ).put( "title", aspect.getPreferredName( config.locale() ) );
( (ObjectNode) rootNode.get( "info" ) ).put( "version", apiVersion );
( (ObjectNode) rootNode.get( "info" ) ).put( AspectModelJsonSchemaVisitor.SAMM_EXTENSION,
((ObjectNode) rootNode.get( "info" )).put( "title", aspect.getPreferredName( config.locale() ) );
((ObjectNode) rootNode.get( "info" )).put( "version", apiVersion );
((ObjectNode) rootNode.get( "info" )).put( AspectModelJsonSchemaVisitor.SAMM_EXTENSION,
aspect.getAspectModelUrn().map( Object::toString ).orElse( "" ) );
setServers( rootNode, config.baseUrl(), apiVersion, READ_SERVER_PATH );
final boolean includePaging = includePaging( aspect, config.pagingOption() );
Expand Down Expand Up @@ -332,7 +335,7 @@ private String getApiVersion( final Aspect aspect, final boolean useSemanticVers
private void setResponseBodies( final Aspect aspect, final ObjectNode jsonNode, final boolean includePaging ) {
final ObjectNode componentsResponseNode = (ObjectNode) jsonNode.get( FIELD_COMPONENTS ).get( FIELD_RESPONSES );
final ObjectNode referenceNode = FACTORY.objectNode()
.put( REF, COMPONENTS_SCHEMAS + ( includePaging ? FIELD_PAGING_SCHEMA : aspect.getName() ) );
.put( REF, COMPONENTS_SCHEMAS + (includePaging ? FIELD_PAGING_SCHEMA : aspect.getName()) );
final ObjectNode contentNode = getApplicationNode( referenceNode );
componentsResponseNode.set( aspect.getName(), contentNode );
contentNode.put( FIELD_DESCRIPTION, "The request was successful." );
Expand Down Expand Up @@ -506,9 +509,25 @@ private ObjectNode getPathsNode( final Aspect aspect, final OpenApiSchemaGenerat

pathNode.set( FIELD_GET, getRequestEndpointsRead( aspect, propertiesNode, config.resourcePath() ) );

boolean includeCrud = config.includeCrud();

if ( includeCrud || config.includePost() ) {
pathNode.set( FIELD_POST, getRequestEndpointsCreate( aspect, propertiesNode, config.resourcePath() ) );
}

if ( includeCrud || config.includePut() ) {
pathNode.set( FIELD_PUT, getRequestEndpointsUpdate( aspect, propertiesNode, config.resourcePath(), true ) );
}

if ( includeCrud || config.includePatch() ) {
pathNode.set( FIELD_PATCH, getRequestEndpointsUpdate( aspect, propertiesNode, config.resourcePath(), false ) );
}

if ( config.includeQueryApi() ) {
pathNode.set( FIELD_POST,
final ObjectNode includeQueryPathNode = FACTORY.objectNode();
includeQueryPathNode.set( FIELD_POST,
getRequestEndpointFilter( aspect, propertiesNode, config.baseUrl(), apiVersion, config.resourcePath() ) );
endpointPathsNode.set( config.baseUrl() + String.format( QUERY_SERVER_PATH, apiVersion ), includeQueryPathNode );
}

final Optional<ObjectNode> operationsNode = getRequestEndpointOperations( aspect, propertiesNode, config.baseUrl(), apiVersion,
Expand All @@ -532,7 +551,7 @@ private Optional<ObjectNode> getRequestEndpointOperations( final Aspect aspect,
objectNode.set( "tags", FACTORY.arrayNode().add( aspect.getName() ) );
objectNode.put( FIELD_OPERATION_ID, FIELD_POST + FIELD_OPERATION + aspect.getName() );
objectNode.set( FIELD_PARAMETERS, getRequiredParameters( parameterNode, isEmpty( resourcePath ) ) );
objectNode.set( "requestBody", FACTORY.objectNode().put( REF, COMPONENTS_REQUESTS + FIELD_OPERATION ) );
objectNode.set( FIELD_REQUEST_BODY, FACTORY.objectNode().put( REF, COMPONENTS_REQUESTS + FIELD_OPERATION ) );
final ObjectNode responseNode = FACTORY.objectNode();
objectNode.set( FIELD_RESPONSES, responseNode );
responseNode.set( "200", FACTORY.objectNode().put( REF, COMPONENTS_RESPONSES + FIELD_OPERATION_RESPONSE ) );
Expand Down Expand Up @@ -603,7 +622,7 @@ private ObjectNode getRequestEndpointFilter( final Aspect aspect, final ObjectNo
objectNode.set( "tags", FACTORY.arrayNode().add( aspect.getName() ) );
objectNode.put( FIELD_OPERATION_ID, FIELD_POST + aspect.getName() );
objectNode.set( FIELD_PARAMETERS, getRequiredParameters( parameterNode, isEmpty( resourcePath ) ) );
objectNode.set( "requestBody", getRequestBodyForFilter() );
objectNode.set( FIELD_REQUEST_BODY, getRequestBodyForFilter() );
objectNode.set( FIELD_RESPONSES, getResponsesForGet( aspect ) );
return objectNode;
}
Expand All @@ -621,6 +640,27 @@ private ObjectNode getRequestEndpointsRead( final Aspect aspect, final ObjectNod
return objectNode;
}

private ObjectNode getRequestEndpointsCreate( final Aspect aspect, final ObjectNode parameterNode, final String resourcePath ) {
final ObjectNode objectNode = FACTORY.objectNode();
objectNode.set( "tags", FACTORY.arrayNode().add( aspect.getName() ) );
objectNode.put( FIELD_OPERATION_ID, FIELD_POST + aspect.getName() );
objectNode.set( FIELD_PARAMETERS, getRequiredParameters( parameterNode, isEmpty( resourcePath ) ) );
objectNode.set( FIELD_REQUEST_BODY, FACTORY.objectNode() );
objectNode.set( FIELD_RESPONSES, getResponsesForGet( aspect ) );
return objectNode;
}

private ObjectNode getRequestEndpointsUpdate( final Aspect aspect, final ObjectNode parameterNode, final String resourcePath,
final boolean isPut ) {
final ObjectNode objectNode = FACTORY.objectNode();
objectNode.set( "tags", FACTORY.arrayNode().add( aspect.getName() ) );
objectNode.put( FIELD_OPERATION_ID, (isPut ? FIELD_PUT : FIELD_PATCH) + aspect.getName() );
objectNode.set( FIELD_PARAMETERS, getRequiredParameters( parameterNode, isEmpty( resourcePath ) ) );
objectNode.set( FIELD_REQUEST_BODY, FACTORY.objectNode() );
objectNode.set( FIELD_RESPONSES, getResponsesForGet( aspect ) );
return objectNode;
}

private ObjectNode getResponsesForGet( final Aspect aspect ) {
final ObjectNode responses = FACTORY.objectNode();
responses.set( "200", getSuccessfulNode( aspect ) );
Expand Down
9 changes: 8 additions & 1 deletion ...in/java/org/eclipse/esmf/aspectmodel/generator/openapi/OpenApiSchemaGenerationConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,14 @@ public record OpenApiSchemaGenerationConfig(
String resourcePath,
ObjectNode properties,
PagingOption pagingOption,
boolean includeQueryApi
boolean includeQueryApi,
boolean includeCrud,

boolean includePost,

boolean includePut,

boolean includePatch
) implements GenerationConfig {
public OpenApiSchemaGenerationConfig {
if ( locale == null ) {
Expand Down
Loading
Loading