org.wso2.apimgt.gateway.cli.utils

Class OpenAPICodegenUtils

java.lang.Object

org.wso2.apimgt.gateway.cli.utils.OpenAPICodegenUtils

public class OpenAPICodegenUtils
extends Object

Utility functions to be used by MGW code generation related component.

Constructor Summary

Constructors

Constructor and Description
OpenAPICodegenUtils()

Method Summary

Modifier and Type	Method and Description
static void	addDefaultAuthProviders(List<String> authProviders)
static String	convertYamlToJson(String yaml)
static String	findSwaggerVersion(String apiDefinition, boolean isFilePath) Discover the openAPI version of the given API definition.
static ExtendedAPI	generateAPIFromOpenAPIDef(io.swagger.v3.oas.models.OpenAPI openAPI, String openAPIContent) generate ExtendedAPI object from openAPI definition.
static List<APIKey>	generateAPIKeysFromSecurity(List<io.swagger.v3.oas.models.security.SecurityRequirement> securityRequirementList, boolean isAPIKeyEnabled) Provide api keys for a given security requirement list.
static ExtendedAPI	generateGrpcAPIFromOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) Generate ExtendedAPI object from generated OpenAPI from protobuf file.
static List<String>	getAuthProviders(String schemas, ApplicationSecurity appSecurity) Get auth providers for given schema.
static String	getMgwResourceScope(io.swagger.v3.oas.models.Operation operation) Get resource level security scopes of Operation if the security scheme is oauth2.
static List<String>	getMgwResourceSecurity(io.swagger.v3.oas.models.Operation operation, ApplicationSecurity appSecurity) Get resource level auth providers as a list of strings.
static String	getOpenAPIAsJson(io.swagger.v3.oas.models.OpenAPI openAPI, String openAPIContent, Path openAPIPath) Convert the v2 or v3 open API definition in yaml or json format into json format of the respective format.
static MgwEndpointConfigDTO	getResourceEpConfigForCodegen(io.swagger.v3.oas.models.Operation operation) get resource Endpoint configuration in the format of MgwEndpointConfigDTO to match the mustache template.
static ApplicationSecurity	populateApplicationSecurity(String apiName, String version, Map<String,Object> apiDefExtensions, String mutualSSL) Get application security from API Definition extension.
static void	setAdditionalConfigsDevFirst(ExtendedAPI api, io.swagger.v3.oas.models.OpenAPI openAPI, String openAPIFilePath)
static void	setInterceptors(String projectName) Store all the interceptor functions included in interceptors directory.
static void	setOauthSecuritySchemaList(io.swagger.v3.oas.models.OpenAPI openAPI) store the security schemas of type "oauth2".
static void	setOpenAPIDefinitionEndpointReferenceExtensions(Map<String,Object> extensions) store the endpoint extensions which are used as references.
static void	setSecuritySchemaList(io.swagger.v3.oas.models.OpenAPI openAPI) store the security schemas of type "basic" and "apikey".
static void	validateOpenAPIDefinition(io.swagger.v3.oas.models.OpenAPI openAPI, String openAPIFilePath, String openAPIVersion) validate the openAPI definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAPICodegenUtils

public OpenAPICodegenUtils()

Method Detail

findSwaggerVersion

public static String findSwaggerVersion(String apiDefinition,
                                        boolean isFilePath)

Discover the openAPI version of the given API definition.

Parameters:

apiDefinition - API definition (as a file path or String content)

isFilePath - If the given api Definition is a file path

Returns:

openAPI version number (2 or 3)

getOpenAPIAsJson

public static String getOpenAPIAsJson(io.swagger.v3.oas.models.OpenAPI openAPI,
                                      String openAPIContent,
                                      Path openAPIPath)

Convert the v2 or v3 open API definition in yaml or json format into json format of the respective format. v2/YAML -> v2/JSON v3/YAML -> v3/JSON

Parameters:

openAPIContent - open API as a string content

Returns:

openAPI definition as a JSON String

convertYamlToJson

public static String convertYamlToJson(String yaml)
                                throws IOException

Throws:

IOException

generateAPIFromOpenAPIDef

public static ExtendedAPI generateAPIFromOpenAPIDef(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                    String openAPIContent)
                                             throws IOException

generate ExtendedAPI object from openAPI definition.

Parameters:

openAPI - OpenAPI object with all required properties

Returns:

ExtendedAPI object

Throws:

IOException

generateGrpcAPIFromOpenAPI

public static ExtendedAPI generateGrpcAPIFromOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

Generate ExtendedAPI object from generated OpenAPI from protobuf file. This is used for the ballerina service generation.

Parameters:

openAPI - OpenAPI object with all required properties

Returns:

ExtendedAPI object for protobuf

setAdditionalConfigsDevFirst

public static void setAdditionalConfigsDevFirst(ExtendedAPI api,
                                                io.swagger.v3.oas.models.OpenAPI openAPI,
                                                String openAPIFilePath)

getResourceEpConfigForCodegen

public static MgwEndpointConfigDTO getResourceEpConfigForCodegen(io.swagger.v3.oas.models.Operation operation)
                                                          throws CLICompileTimeException

get resource Endpoint configuration in the format of MgwEndpointConfigDTO to match the mustache template.

Parameters:

operation - Operation object

Returns:

MgwEndpointConfigDTO object

Throws:

CLICompileTimeException

setInterceptors

public static void setInterceptors(String projectName)
                            throws IOException

Store all the interceptor functions included in interceptors directory.

Throws:

IOException - if an error occurred while reading the bal files inside interceptor directory

populateApplicationSecurity

public static ApplicationSecurity populateApplicationSecurity(String apiName,
                                                              String version,
                                                              Map<String,Object> apiDefExtensions,
                                                              String mutualSSL)

Get application security from API Definition extension.

Parameters:

apiDefExtensions - API definition extesnsions

Returns:

ApplicationSecurity/null if not present returns null

getMgwResourceSecurity

public static List<String> getMgwResourceSecurity(io.swagger.v3.oas.models.Operation operation,
                                                  ApplicationSecurity appSecurity)

Get resource level auth providers as a list of strings.

Parameters:

operation - operation Operation

appSecurity - Application security object ApplicationSecurity

Returns:

auth provider array

getMgwResourceScope

public static String getMgwResourceScope(io.swagger.v3.oas.models.Operation operation)

Get resource level security scopes of Operation if the security scheme is oauth2.

Parameters:

operation - Operation

Returns:

comma separated set of scopes (ex. 'read:pets, write:pets')

generateAPIKeysFromSecurity

public static List<APIKey> generateAPIKeysFromSecurity(List<io.swagger.v3.oas.models.security.SecurityRequirement> securityRequirementList,
                                                       boolean isAPIKeyEnabled)

Provide api keys for a given security requirement list.

Parameters:

securityRequirementList - List object

Returns:

list of API Keys

validateOpenAPIDefinition

public static void validateOpenAPIDefinition(io.swagger.v3.oas.models.OpenAPI openAPI,
                                             String openAPIFilePath,
                                             String openAPIVersion)

validate the openAPI definition.

Parameters:

openAPI - OpenAPI object

openAPIFilePath - file path to openAPI definition

setOauthSecuritySchemaList

public static void setOauthSecuritySchemaList(io.swagger.v3.oas.models.OpenAPI openAPI)

store the security schemas of type "oauth2".

Parameters:

openAPI - OpenAPI object

setSecuritySchemaList

public static void setSecuritySchemaList(io.swagger.v3.oas.models.OpenAPI openAPI)

store the security schemas of type "basic" and "apikey".

Parameters:

openAPI - OpenAPI object

setOpenAPIDefinitionEndpointReferenceExtensions

public static void setOpenAPIDefinitionEndpointReferenceExtensions(Map<String,Object> extensions)

store the endpoint extensions which are used as references.

Parameters:

extensions - Map object

getAuthProviders

public static List<String> getAuthProviders(String schemas,
                                            ApplicationSecurity appSecurity)

Get auth providers for given schema.

Parameters:

schemas - oas definition schemas

appSecurity - security defined by the extension

Returns:

list of auth providers

addDefaultAuthProviders

public static void addDefaultAuthProviders(List<String> authProviders)