We want to set up an OAS API using the REST API and have it backed by basic API keys. FYI our gateway is running behind an Istio Ingress.
Here’s our query:
POST https://some-gateway.url/tyk/apis/oas
{
"openapi": "3.0.1",
"info": {
"title": "some-api",
"version": "v1"
},
"servers": [
{
"url": "/"
}
],
"security": [
{
"api_auth": []
}
],
"tags": [
{
"name": "SomeService"
}
],
"paths": {
"/v1/content": {
"post": {
"tags": [
"SomeService"
],
"summary": "Offers is a rpc call and a option is defined for it",
"operationId": "SomeService_Content",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/servicessomev1ContentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "A successful response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/servicessomev1ContentResponse"
}
}
}
},
"default": {
"description": "An unexpected error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rpcStatus"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
}
},
"components": {
"schemas": {
"entitiesContent": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"globalId": {
"type": "string"
},
"distributionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"$ref": "#/components/schemas/protobufAny"
}
}
},
"entitiesLocation": {
"type": "object",
"properties": {
"longitude": {
"type": "number",
"format": "float"
},
"latitude": {
"type": "number",
"format": "float"
}
}
},
"entitiesUserContext": {
"type": "object",
"properties": {
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/entitiesLocation"
}
}
}
},
"protobufAny": {
"type": "object",
"properties": {
"@type": {
"type": "string",
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
}
},
"additionalProperties": {
"type": "object"
},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\nExample 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\nExample 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }"
},
"rpcStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/protobufAny"
}
}
}
},
"servicessomev1ContentRequest": {
"title": "simple message",
"type": "object",
"properties": {
"userContext": {
"$ref": "#/components/schemas/entitiesUserContext"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v1ContentQuery"
}
}
}
},
"servicessomev1ContentResponse": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/entitiesContent"
}
}
}
},
"v1ContentQuery": {
"type": "object",
"properties": {
"keyword": {
"type": "string"
}
}
}
},
"securitySchemes": {
"api_key": {
"in": "header",
"name": "api_key",
"type": "apiKey"
}
}
},
"x-tyk-api-gateway": {
"info": {
"name": "some-api",
"state": {
"active": true
}
},
"upstream": {
"url": "http://some.some.svc.cluster.local:8001"
},
"server": {
"authentication": {
"enabled": true,
"stripAuthorizationData": true,
"baseIdentityProvider": "auth_token"
},
"listenPath": {
"value": "/api/",
"strip": false
}
}
}
}
We’re noticing a few confusing things that the docs aren’t making clear:
- Using the REST API doesn’t seem create an organization ID. The org_id we get back is “”. We’ve also tried a k8s using a CRD, which creates an org ID. Is org ID even needed? If so, how does that get created. We don’t see anything in the API for that at all.
- We’re very confused about the difference between upstream URL and servers at the root. Is Upstream the same as target_url? What are servers? Can we leave that as “/”?
- We’re also confused about the settings to use a simple API Key for access. Do we not need the security, securitySchemes, and x-tyk-gateway.server.authentication settings? If we turn those off, will it default to basic API Key auth?
- We’ve managed to create the OAS API, but the keys we’re creating don’t seem to be working.
POST to /tyk/keys
{
"access_rights": {
"OUR_API_ID": {
"api_name": "some-api",
"api_id": "OUR_API_ID",
"versions": [
"Default"
]
}
},
"quota_max": -1,
"quota_renews": 1406121006,
"quota_renewal_rate": 86400,
"allowance": 100000000,
"rate": 100000,
"per": 5
}
That produces the key, but when we pass that in the Authorization header it returns:
{
"error": "Access to this API has been disallowed"
}