dry Run Api OAS
POST {{baseUrl}}/api/apis/oas/dry-run?upstreamURL=<string>&listenPath=<string>&customDomain=<string>&allowList=true&validateRequest=true&mockResponse=true&authentication=true&templateID=<string>
Generate a Tyk OAS API definition without saving it to the Dashboard database. This endpoint is used to produce a Tyk OAS API definition without creating the API proxy itself. This provides a dry run functionality for Tyk OAS API creation, showing what would be created in the Dashboard given the set of inputs provided.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
upstreamURL | string | Upstream URL for the API | |
listenPath | string | Listen path for the API | |
customDomain | string | Custom domain for the API | |
allowList | boolean | Enable allowList middleware for all endpoints | |
validateRequest | boolean | Enable validateRequest middleware for all endpoints having a request body with media type application/json | |
mockResponse | boolean | Enable mockResponse middleware for all endpoints having responses configured. | |
authentication | boolean | Enable/disable the authentication mechanism in your Tyk Gateway for your OAS API | |
templateID | string | The asset ID of template to apply while importing an OAS API. |
Request Body
{"oas"=>{"value"=>"reference https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json not found in the OpenAPI spec"}, "tyk_oas"=>{"x-tyk-api-gateway"=>{"info"=>{"id"=>"<string>", "dbId"=>"<string>", "orgId"=>"<string>", "name"=>"<string>", "state"=>{"active"=>"<boolean>"}}, "upstream"=>{"url"=>"<string>"}, "server"=>{"listenPath"=>{"value"=>"<string>", "strip"=>"<boolean>"}}}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"x-tyk-api-gateway":{"info":{"id":"\u003cstring\u003e","dbId":"\u003cstring\u003e","orgId":"\u003cstring\u003e","name":"\u003cstring\u003e","state":{"active":"\u003cboolean\u003e"}},"upstream":{"url":"\u003cstring\u003e"},"server":{"listenPath":{"value":"\u003cstring\u003e","strip":"\u003cboolean\u003e"}}}}