1. Proxies and Flow

api

The api proxy extends the serviceProxy with API related functions like OpenAPI support and path parameters.

Can be used in:

router and bean

Syntax

<api name="string"
	 port="integer"
	 method="[*,POST,PUT,GET,DELETE,TRACE,OPTIONS]"
	 host="[string,*]"
	 ip="[ip]">
  <path />?
  <ssl />?
  <request>
    [interceptors]*
  </request>
    [interceptors]*
  <response>
    [interceptors]*
  </response>
  <localhost />?
  <target />?
</api>

Sample

<api port="2000">
  <target url="https://api.predic8.de"/>
</api>
Simple forwarding API from port 2000 to https://api.predic8.de 

<api port="2000">
  <openapi location="fruitshop-api-v1.oas.yaml"/>
</api>
API from OpenAPI YAML file

Attributes

NameRequiredDefaultDescriptionExamples
blockRequest false false
 legacy attribute for usage by Membrane Monitor
-
method false *
 If set, Membrane will only consider this rule, if the method (GET, PUT, POST, DELETE, etc.) header of incoming HTTP requests matches. The asterisk '*' matches any method.
GET
test false - - -
port false 80
 The port Membrane listens on for incoming connections.
8080
ip false not set
 If present, binds the port only on the specified IP. Useful for hosts with multiple IP addresses.
127.0.0.1
name false By default, a name will be automatically generated from the target host, port, etc.
 The name as shown in the Admin Console.
-
blockResponse false false
 legacy attribute for usage by Membrane Monitor
-
host false not set

A space separated list of hostnames. If set, Membrane will only consider this rule, if the "Host" header of incoming HTTP requests matches one of the hostnames.

The asterisk '*' can be used for basic globbing (to match any number, including zero, characters).


 predic8.de *.predic8.de
language false - - -

Child Elements

ElementsDescriptionCardinality
description 0..1
openapi Deploys an API from an OpenAPI document. 0..*
path If set, Membrane will only consider this rule, if the path of incoming HTTP requests matches. {@link Path} supports starts-with and regex matching. If used in a {@link SOAPProxy}, this causes path rewriting of SOAP requests and in the WSDL to automatically be configured. 0..1
ssl Configures the usage of inbound SSL (HTTPS). 0..1
echo 0..*
request 0..*
abort 0..*
response 0..*
target 0..1

Other optional Child Elements

tcp, requireAuth, authHead2Body, wsaEndpointRewriter, openTelemetry, statisticsCSV, login, limit, shadowing, clusterNotification, throttle, userFeature, webSocket, cors, acmeHttpChallenge, call, httpClient, soap2Rest, static, accessLog, webServiceExplorer, stompClient, clamav, exchangeStore, formValidation, oauth2PermissionChecker, rateLimiter, apiDocs, statisticsJDBC, soapBody, logContext, internalRouting, counter, xml2Json, idempotency, adminApi, balancer, openapiPublisher, setCookies, headerFilter, destination, beautifier, groovyTemplate, jwtSign, cache, shutdown, openapiValidator, kubernetesValidation, webServer, xmlProtection, APIsJSON, accessControl, accountRegistration, basicAuthentication, chain, for, xenAuthentication, analyser, methodOverride, jsonProtection, choose, urlNormalizer, ruleMatching, ntlm, javascript, flowInitiator, graphQLProtection, paddingHeader, interceptor, dispatching, if, wsdlPublisher, http2xml, setHeader, groovy, wadlRewriter, adminConsole, xmlContentFilter, validator, json2Xml, rewriter, apiKey, log, prometheus, index, oauth2authserver, greaser, soapOperationExtractor, transform, global, soapStackTraceFilter, return, regExReplacer, reverseProxying, rest2Soap, sampleSoapService, testService, setProperty, tokenValidator, wsdlRewriter, jwtAuth, statisticsProvider, replace, oauth2Resource2, template