x-apigateway-backend-policies

Meaning: API backend policy.

Scope of effect: Operation Object (2.0)/Operation Object (3.0)

Example:

paths:
  '/users/{userId}':
    get:
      produces:
        - "application/json"
      responses:
        default:
          description: "default response"
      x-apigateway-request-type: "public"
      x-apigateway-backend:
        type: "backend endpoint type"
      x-apigateway-backend-policies:
        - type: "backend endpoint type"
          name: "backend policy name"
          conditions: 
            - type: "equal/enum/pattern",
              value: "string",
              origin: "source/request_parameter",
              parameter_name: "string"

Table 1 Parameter description
Parameter	Mandatory	Type	Description
x-apigateway-backend-policies	No	x-apigateway-backend-policies	Backend policies.
type	Yes	String	Backend service type. The options include HTTP, HTTP-VPC, FUNCTION, and MOCK.
name	Yes	String	Backend policy name.
parameters	No	x-apigateway-backend.parameters	Backend parameters.
httpEndpoints	No	x-apigateway-backend.httpEndpoints	HTTP service definition.
httpVpcEndpoints	No	x-apigateway-backend.httpVpcEndpoints	HTTP-VPC service definition.
functionEndpoints	No	x-apigateway-backend.functionEndpoints	Function service definition.
mockEndpoints	No	x-apigateway-backend.mockEndpoints	Mock service definition.
conditions	Yes	x-apigateway-backend-policies.conditions	Policy condition array.

Parent topic: API Design File Extension Definitions

Предыдущая статья

x-apigateway-backend.mockEndpoints

Следующая статья

x-apigateway-backend-policies.conditions

Была ли эта статья полезна?

Поддержка Юридические документы