Package org.eclipse.lemminx.customservice.synapse.api.generator

Class RestApiAdmin

java.lang.Object

org.eclipse.lemminx.customservice.synapse.api.generator.RestApiAdmin

public class RestApiAdmin
extends Object

Constructor Summary

Constructors

Constructor	Description
RestApiAdmin()

Method Summary

Modifier and Type	Method	Description
static String	convertJSONtoYaml(String jsonSource)
GenerateAPIResponse	createAPI(String apiName, String sourcePath, String endpoint, String publishSwaggerPath, String mode)	Function to create API from Swagger or WSDL.
GenerateAPIResponse	createAPI(GenerateAPIParam param)
GenerateSwaggerResponse	generateSwaggerFromAPI(GenerateSwaggerParam param)	Function to generate Swagger from API.
GenerateSwaggerResponse	generateSwaggerFromSynapseAPIByFormat(String apiPath, boolean isJSON, int port)	Function to generate API from synapse API.
String	generateSwaggerFromSynapseAPIByFormat(API api, boolean isJSON, int port)	Function to generate API from swagger definition (from Synapse API).
String	generateUpdatedSwaggerFromAPI(String existingSwagger, boolean isJSONIn, boolean isJSONOut, API api, int port)	Generate updated OpenApi definition using an updated API.
Boolean	isEqualSwaggers(IsEqualSwaggersParam param)	Function to compare two swagger contents
String	updateNameInSwagger(String newName, String swagger)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RestApiAdmin

public RestApiAdmin()

Method Details

createAPI

public GenerateAPIResponse createAPI(GenerateAPIParam param)

createAPI

public GenerateAPIResponse createAPI(String apiName,
 String sourcePath,
 String endpoint,
 String publishSwaggerPath,
 String mode)

Function to create API from Swagger or WSDL.

Parameters:

apiName - API name

sourcePath - Swagger or WSDL file path

endpoint - WSDL endpoint

publishSwaggerPath - Swagger publish path

mode - Mode of the API creation (Swagger / WSDL)

Returns:

updateNameInSwagger

public String updateNameInSwagger(String newName,
 String swagger)
                           throws APIException

Throws:

APIException

convertJSONtoYaml

public static String convertJSONtoYaml(String jsonSource)
                                throws Exception

Throws:

Exception

generateSwaggerFromAPI

public GenerateSwaggerResponse generateSwaggerFromAPI(GenerateSwaggerParam param)

Function to generate Swagger from API.

Parameters:

param - Swagger generation parameters

Returns:

generated Swagger

isEqualSwaggers

public Boolean isEqualSwaggers(IsEqualSwaggersParam param)

Function to compare two swagger contents

Parameters:

param - Swagger compare parameters

Returns:

boolean

generateSwaggerFromSynapseAPIByFormat

public GenerateSwaggerResponse generateSwaggerFromSynapseAPIByFormat(String apiPath,
 boolean isJSON,
 int port)

Function to generate API from synapse API.

Parameters:

apiPath - API file path

Returns:

generated API

generateSwaggerFromSynapseAPIByFormat

public String generateSwaggerFromSynapseAPIByFormat(API api,
 boolean isJSON,
 int port)

Function to generate API from swagger definition (from Synapse API).

Parameters:

api - api existing synapse API

isJSON - generate Swagger in YAML / JSON format.

Returns:

generated swagger.

generateUpdatedSwaggerFromAPI

public String generateUpdatedSwaggerFromAPI(String existingSwagger,
 boolean isJSONIn,
 boolean isJSONOut,
 API api,
 int port)
                                     throws APIGenException

Generate updated OpenApi definition using an updated API.

Parameters:

existingSwagger - existing OpenApi definition of the API.

isJSONIn - input data-type JSON / YAML.

isJSONOut - output required in JSON / YAML.

api - updated synapse API.

Returns:

OpenApi definition of the updated API.

Throws:

APIGenException - Error occurred while generating the updated definition.