Package com.predic8.membrane.core.openapi.serviceproxy

Class OpenAPISpec

java.lang.Object

com.predic8.membrane.core.openapi.serviceproxy.OpenAPISpec

public class OpenAPISpec
extends Object

Description

Reads an OpenAPI description and deploys an API with the information of it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenAPISpec.YesNoOpenAPIOption

Field Summary

Fields

Modifier and Type	Field	Description
String	dir
String	location
OpenAPISpec.YesNoOpenAPIOption	validateRequests
OpenAPISpec.YesNoOpenAPIOption	validateResponses
OpenAPISpec.YesNoOpenAPIOption	validateSecurity
OpenAPISpec.YesNoOpenAPIOption	validationDetails

Constructor Summary

Constructors

Constructor	Description
OpenAPISpec()

Method Summary

Modifier and Type	Method	Description
String	getDir()
String	getLocation()
Rewrite	getRewrite()
OpenAPISpec.YesNoOpenAPIOption	getValidateRequests()
OpenAPISpec.YesNoOpenAPIOption	getValidateResponses()
OpenAPISpec.YesNoOpenAPIOption	getValidateSecurity()
OpenAPISpec.YesNoOpenAPIOption	getValidationDetails()
boolean	hasRewrite()
void	setDir(String dir)
void	setLocation(String location)
void	setRewrite(Rewrite rewrite)
void	setValidateRequests(OpenAPISpec.YesNoOpenAPIOption validateRequests)
void	setValidateResponses(OpenAPISpec.YesNoOpenAPIOption validateResponses)
void	setValidateSecurity(OpenAPISpec.YesNoOpenAPIOption validateSecurity)
void	setValidationDetails(OpenAPISpec.YesNoOpenAPIOption validationDetails)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

location

public String location

dir

public String dir

validateRequests

public OpenAPISpec.YesNoOpenAPIOption validateRequests

validateResponses

public OpenAPISpec.YesNoOpenAPIOption validateResponses

validationDetails

public OpenAPISpec.YesNoOpenAPIOption validationDetails

validateSecurity

public OpenAPISpec.YesNoOpenAPIOption validateSecurity

Constructor Details

OpenAPISpec

public OpenAPISpec()

Method Details

hasRewrite

public boolean hasRewrite()

setRewrite

public void setRewrite(Rewrite rewrite)

getRewrite

public Rewrite getRewrite()

getLocation

public String getLocation()

setLocation

public void setLocation(String location)

Description

Filename or URL pointing to an OpenAPI document. Relative filenames use the %MEMBRANE_HOME%/conf folder as base directory.

Example

openapi/fruitstore-v1.yaml, https://api.predic8.de/shop/swagger

getDir

public String getDir()

setDir

public void setDir(String dir)

Description

Directory containing OpenAPI definitions to deploy.

Example

openapi

getValidateRequests

public OpenAPISpec.YesNoOpenAPIOption getValidateRequests()

setValidateRequests

public void setValidateRequests(OpenAPISpec.YesNoOpenAPIOption validateRequests)

Default

no

Description

Turn validation of requests on or off.

Example

yes

getValidateResponses

public OpenAPISpec.YesNoOpenAPIOption getValidateResponses()

setValidateResponses

public void setValidateResponses(OpenAPISpec.YesNoOpenAPIOption validateResponses)

Default

no

Description

Turn validation of responses on or off.

Example

yes

setValidationDetails

public void setValidationDetails(OpenAPISpec.YesNoOpenAPIOption validationDetails)

Default

no

Description

Show details of the validation to the caller.

Example

yes

getValidationDetails

public OpenAPISpec.YesNoOpenAPIOption getValidationDetails()

getValidateSecurity

public OpenAPISpec.YesNoOpenAPIOption getValidateSecurity()

setValidateSecurity

public void setValidateSecurity(OpenAPISpec.YesNoOpenAPIOption validateSecurity)

toString

public String toString()

Overrides:

toString in class Object