x-apigateway-backend

Meaning: API backend definition.

Scope of effect: Operation Object (2.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"

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

Parent topic: x-apigateway-backend

Previous topic: x-apigateway-backend

Next topic: x-apigateway-backend.parameters

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.