Skip to content

Open Api Extensions

Praminda edited this page Nov 4, 2019 · 1 revision
Extension Description Required/Not Required
x-wso2-basePath Base path which gateway exposes the API Required -> API level only
x-wso2-production-endpoints Specify the actual back end of the service Required -> API level/ Not required -> Resource level
x-wso2-sandbox-endpoints Specify the sandbox endpoint of the service if available Not Required -> API/Resource level
x-wso2-throttling-tier Specify the rate limiting for the API or resource Not Required -> API/Resource level
x-wso2-cors Specify CORS configuration for the API Not Required -> API level only
x-wso2-endpoints Define endpoint configs globally which can be then referred with x-wso2-production-endpoints or x-wso2-sandbox-endpoints extensions Not Required
x-wso2-disable-security Resource can be invoked without any authentication Not Required -> Resource level only
x-wso2-request-interceptor Custom ballerina functions can be written in order to do transformations before dispatching the request Not Required -> API/Resource level
x-wso2-response-interceptor Custom ballerina functions can be written in order to do transformations before dispatching the response Not Required -> API/Resource level
x-wso2-auth-header Specify the authorization header for the API in which either bearer or basic token is sent Not Required -> API level only
Clone this wiki locally