org.ballerinalang.composer.service.workspace.swagger

Class SwaggerConverterUtils

java.lang.Object

org.ballerinalang.composer.service.workspace.swagger.SwaggerConverterUtils

public class SwaggerConverterUtils
extends Object

Swagger related utility classes.

Constructor Summary

Constructors

Constructor and Description
SwaggerConverterUtils()

Method Summary

Modifier and Type	Method and Description
static String	capitalize(String str)
static String	generateBallerinaDataModel(String swaggerDefinition, String ballerinaDefinition) This method will generate ballerina string from swagger definition.
static String	generateServiceUUID(String path, String verb) This will generate UUID specific to given resource.
static String	generateSwaggerDataModel(String ballerinaDefinition) This method will convert ballerina definition to swagger string.
static org.ballerinalang.model.BallerinaFile	getBFileFromBallerinaDefinition(String ballerinaDefinition) Generate ballerina fine from the String definition
static org.ballerinalang.model.Service	getServiceFromSwaggerDefinition(String swaggerDefinition) This method will generate Ballerina service from Swagger definition.
static org.ballerinalang.model.Service[]	getServicesFromBallerinaDefinition(String ballerinaDefinition) This method will extract service definitions from ballerina source
static boolean	isResourceUUIDMatch(org.ballerinalang.model.Resource swaggerResource, org.ballerinalang.model.Resource ballerinaResource) Check if 2 resources are having same UUID.
static org.ballerinalang.model.Resource[]	mapPathsToResources(Map<String,io.swagger.models.Path> pathMap)
static org.ballerinalang.model.Resource[]	mapSwaggerPathsToResources(List<io.swagger.codegen.CodegenOperation> pathMap) This method will convert swagger path List into ballerina @Resource array
static org.ballerinalang.model.Annotation[]	mergeAnnotations(org.ballerinalang.model.Annotation[] annotations, org.ballerinalang.model.Annotation[] annotationsToMerge) This method will merge annotations from two different services or resources.
static org.ballerinalang.model.Service	mergeBallerinaService(org.ballerinalang.model.Service ballerinaService, org.ballerinalang.model.Service swaggerService) This method will merge swagger definition based to ballerina service.
static org.ballerinalang.model.Resource[]	mergeResources(List<org.ballerinalang.model.Resource> resourceList, org.ballerinalang.model.Resource[] resources) Remove duplicate resources and merge them.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerConverterUtils

public SwaggerConverterUtils()

Method Detail

getServicesFromBallerinaDefinition

public static org.ballerinalang.model.Service[] getServicesFromBallerinaDefinition(String ballerinaDefinition)
                                                                            throws IOException

This method will extract service definitions from ballerina source

Parameters:

ballerinaDefinition - service definition to be process as ballerina

Returns:

service list which contain all services within give ballerina source

Throws:

IOException - when input stream handling error.

getBFileFromBallerinaDefinition

public static org.ballerinalang.model.BallerinaFile getBFileFromBallerinaDefinition(String ballerinaDefinition)
                                                                             throws IOException

Generate ballerina fine from the String definition

Parameters:

ballerinaDefinition - ballerina string definition

Returns:

ballerina file created from ballerina string definition

Throws:

IOException - IO exception

getServiceFromSwaggerDefinition

public static org.ballerinalang.model.Service getServiceFromSwaggerDefinition(String swaggerDefinition)
                                                                       throws IOException

This method will generate Ballerina service from Swagger definition.

Parameters:

swaggerDefinition - Swagger definition

Returns:

service generated from Swagger definition

Throws:

IOException - IO exception

mapSwaggerPathsToResources

public static org.ballerinalang.model.Resource[] mapSwaggerPathsToResources(List<io.swagger.codegen.CodegenOperation> pathMap)

This method will convert swagger path List into ballerina @Resource array

Parameters:

pathMap - Swagger @CodegenOperation list to be processed

Returns:

Resource array generated from pathMap

mapPathsToResources

public static org.ballerinalang.model.Resource[] mapPathsToResources(Map<String,io.swagger.models.Path> pathMap)

Parameters:

pathMap - Swagger path map

Returns:

resource array

mergeBallerinaService

public static org.ballerinalang.model.Service mergeBallerinaService(org.ballerinalang.model.Service ballerinaService,
                                                                    org.ballerinalang.model.Service swaggerService)

This method will merge swagger definition based to ballerina service.

Parameters:

ballerinaService - ballerina service

swaggerService - swagger service

Returns:

merged service

mergeAnnotations

public static org.ballerinalang.model.Annotation[] mergeAnnotations(org.ballerinalang.model.Annotation[] annotations,
                                                                    org.ballerinalang.model.Annotation[] annotationsToMerge)

This method will merge annotations from two different services or resources.

Parameters:

annotations - annotations array

annotationsToMerge - annotations array to merge

Returns:

merged annotations

isResourceUUIDMatch

public static boolean isResourceUUIDMatch(org.ballerinalang.model.Resource swaggerResource,
                                          org.ballerinalang.model.Resource ballerinaResource)

Check if 2 resources are having same UUID.

Parameters:

swaggerResource - Swagger resource

ballerinaResource - Ballerina resources

Returns:

whether UUIDs for Swagger and Ballerina resources are matching

generateServiceUUID

public static String generateServiceUUID(String path,
                                         String verb)

This will generate UUID specific to given resource.

Parameters:

path - path

verb - verb

Returns:

generated UUID

capitalize

public static String capitalize(String str)

mergeResources

public static org.ballerinalang.model.Resource[] mergeResources(List<org.ballerinalang.model.Resource> resourceList,
                                                                org.ballerinalang.model.Resource[] resources)

Remove duplicate resources and merge them.

Parameters:

resourceList - resources list

resources - resources array

Returns:

merged resources array without duplicates

generateSwaggerDataModel

public static String generateSwaggerDataModel(String ballerinaDefinition)
                                       throws IOException

This method will convert ballerina definition to swagger string. Since swagger is subset of ballerina definition we can implement converter logic without data loss.

Parameters:

ballerinaDefinition - String ballerina config to be processed as ballerina service definition

Returns:

swagger data model generated from ballerina definition

Throws:

IOException - when input process error occur.

generateBallerinaDataModel

public static String generateBallerinaDataModel(String swaggerDefinition,
                                                String ballerinaDefinition)
                                         throws IOException

This method will generate ballerina string from swagger definition. Since ballerina service definition is super set of swagger definition we will take both swagger and ballerina definition and merge swagger changes to ballerina definition selectively to prevent data loss

Parameters:

swaggerDefinition - swagger definition to be processed as swagger

ballerinaDefinition - ballerina definition to be process as ballerina definition

Returns:

String representation of converted ballerina source

Throws:

IOException - when error occur while processing input swagger and ballerina definitions.