All Products
Search
Document Center

API Gateway:HttpApiOperation

Last Updated:Aug 28, 2026

Parameter

Type

Description

Example

object

The operation in the HTTP API definition.

method

string

The HTTP method.

Valid values:

  • TRACE

  • HEAD

  • DELETE

  • POST

  • GET

  • CONNECT

  • OPTIONS

  • PUT

  • PATCH

GET

name

string

The operation name.

GetUserInfo

path

string

The operation path.

/user

description

string

The operation description.

获取用户信息

response HttpApiResponseContract

The response parameters.

request HttpApiRequestContract

The request parameters.

mock HttpApiMockContract

The mock configuration. Takes effect only when the publishing scenario is set to Mock.

enableAuth

boolean

Whether to enable authentication.

true

authConfig AuthConfig

The authentication configuration.

deployConfigs

array

The deployment configurations.

HttpApiDeployConfig

object