org.wso2.apimgt.gateway.cli.utils

Class OpenAPICodegenUtils

java.lang.Object

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

public class OpenAPICodegenUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenAPICodegenUtils()

Method Summary

Modifier and Type	Method and Description
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, Path openAPIPath) generate ExtendedAPI object from openAPI definition
static BasicAuth	generateBasicAuthFromSecurity(String schemas) When the security schema string is provided as a comma separated set of values generate the corresponding schema string.
static BasicAuth	getMgwResourceBasicAuth(io.swagger.v3.oas.models.Operation operation)
static String	getMgwResourceScope(io.swagger.v3.oas.models.Operation operation) Get resource level security scopes of Operation if the security scheme is oauth2.
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
static ResourceRepresentation	getResource(String projectName, String resource_id) get the resource related information if the resource_id is given
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 List<ResourceRepresentation>	listResourcesFromSwaggerForAPI(String projectName, String apiId) list all the available resources from openAPI definition
static void	setAdditionalConfig(ExtendedAPI api)
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	validateOpenAPIDefinition(io.swagger.v3.oas.models.OpenAPI openAPI, String openAPIFilePath) 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

generateAPIFromOpenAPIDef

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

generate ExtendedAPI object from openAPI definition

Parameters:

openAPI - OpenAPI object

Returns:

Extended API object

Throws:

IOException

listResourcesFromSwaggerForAPI

public static List<ResourceRepresentation> listResourcesFromSwaggerForAPI(String projectName,
                                                                          String apiId)

list all the available resources from openAPI definition

Parameters:

projectName - project Name

apiId - api Id

Returns:

list of string arrays {resource_id, resource name, method}

getResource

public static ResourceRepresentation getResource(String projectName,
                                                 String resource_id)

get the resource related information if the resource_id is given

Parameters:

projectName - project name

resource_id - resource id

Returns:

resource object with api name, version, method and key

setAdditionalConfig

public static void setAdditionalConfig(ExtendedAPI api)

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)

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

Parameters:

operation - Operation object

Returns:

MgwEndpointConfigDTO object

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

getMgwResourceBasicAuth

public static BasicAuth getMgwResourceBasicAuth(io.swagger.v3.oas.models.Operation operation)

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')

generateBasicAuthFromSecurity

public static BasicAuth generateBasicAuthFromSecurity(String schemas)

When the security schema string is provided as a comma separated set of values generate the corresponding schema string.

Parameters:

schemas - comma separated security security schema types (ex. basic,oauth2)

Returns:

BasicAuth object

validateOpenAPIDefinition

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

validate the openAPI definition

Parameters:

openAPI - OpenAPI object

openAPIFilePath - file path to openAPI definition