Package org.forgerock.api.transform

Class OpenApiTransformer

java.lang.Object

org.forgerock.api.transform.OpenApiTransformer

public class OpenApiTransformer
extends Object

Transforms an ApiDescription into an OpenAPI/Swagger model.

See Also:

OpenAPI 2.0 spec

Method Summary

Modifier and Type	Method	Description
static io.swagger.models.Swagger	execute(ApiDescription apiDescription, ApiDescription... externalApiDescriptions)	Transforms an ApiDescription into a Swagger model.
static io.swagger.models.Swagger	execute(LocalizableString title, String host, String basePath, boolean secure, ApiDescription apiDescription, ApiDescription... externalApiDescriptions)	Transforms an ApiDescription into a Swagger model.

Methods inherited from class java.lang.Object

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

Method Detail

execute

public static io.swagger.models.Swagger execute(LocalizableString title,
                                                String host,
                                                String basePath,
                                                boolean secure,
                                                ApiDescription apiDescription,
                                                ApiDescription... externalApiDescriptions)

Transforms an ApiDescription into a Swagger model.

Parameters:

title - API title

host - Hostname or IP address, with optional port

basePath - Base-path on host

secure - true when host is using HTTPS and false when using HTTP

apiDescription - CREST API Descriptor

externalApiDescriptions - External CREST API Descriptions, for resolving References, or null

Returns:

Swagger model

execute

public static io.swagger.models.Swagger execute(ApiDescription apiDescription,
                                                ApiDescription... externalApiDescriptions)

Transforms an ApiDescription into a Swagger model.

Note: The returned descriptor does not contain an Info object, a base path, a host or a scheme, as these will all depend on the deployment and/or request.

Parameters:

apiDescription - CREST API Descriptor

externalApiDescriptions - External CREST API Descriptions, for resolving References, or null

Returns:

Swagger model