Swagger Extensions

Extensions, or vendor extensions, are custom properties that start with x-, such as x-logo. They can be used to describe extra functionality that is not covered by the standard Swagger specification. Many API-related products that support Swagger make use of extensions to document their own attributes, such as Amazon API Gateway, ReDoc, APIMatic and others. Extensions are supported on the root level of the API spec and in the following places:

info section
paths section, individual paths and operations
operation parameters
responses
tags
security schemes

The extension value can be a primitive, an array, an object or null. If the value is an object or array of objects, the object’s property names do not need to start with x-.

Example

An API that uses Amazon API Gateway custom authorizer would include extensions similar to this:

1
securityDefinitions:
2
  APIGatewayAuthorizer:
3
    type: apiKey
4
    name: Authorization
5
    in: header
6
    x-amazon-apigateway-authtype: oauth2
7
    x-amazon-apigateway-authorizer:
8
      type: token
9
      authorizerUri: arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:account-id:function:function-name/invocations
10
      authorizerCredentials: arn:aws:iam::account-id:role
11
      identityValidationExpression: "^x-[a-z]+"
12
      authorizerResultTtlInSeconds: 60

Did not find what you were looking for? Ask the community
Found a mistake? Let us know