Files

Chen, Junjie 324aa7d3c4 APIG UMN 20240708 version

Reviewed-by: Mützel, Andrea <andrea.muetzel@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

2024-11-05 15:25:06 +00:00

9.9 KiB

Raw Permalink Blame History

x-apigateway-backend

Meaning: API backend definition.

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"

**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: Extended Definition

9.9 KiB Raw Permalink Blame History

x-apigateway-backend

9.9 KiB

Raw Permalink Blame History