openapi

Version

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

Syntax

openapi:
dir: <string>
location: <string>
rewrite: {}
validateRequests: <boolean>
validateResponses: <boolean>
validateSecurity: <boolean>
validationDetails: <boolean>
openapi:
  dir: <string>
  location: <string>
  rewrite: {}
  validateRequests: <boolean>
  validateResponses: <boolean>
  validateSecurity: <boolean>
  validationDetails: <boolean>

Attributes

NameRequiredDefaultDescriptionExamples
dirfalse-Directory containing OpenAPI definitions to deploy.openapi
locationfalse-Filename or URL pointing to an OpenAPI document. Relative filenames use the %MEMBRANE_HOME%/conf folder as base directory.openapi/fruitstore-v1.yaml, https://api.predic8.de/shop/swagger
validateRequestsfalsenoTurn validation of requests on or off.yes
validateResponsesfalsenoTurn validation of responses on or off.yes
validateSecurityfalse---
validationDetailsfalsenoShow details of the validation to the caller.yes

Child Structure

ElementCardinalityDescription
rewrite0..1

Can be used in