All Products
Search
Document Center

API Gateway:HttpApiOperation

Last Updated:Feb 04, 2026
ParameterTypeDescriptionExample
object

The operation in the HTTP API definition.

methodstring

The HTTP method.

Valid values:

  • TRACE
  • HEAD
  • DELETE
  • POST
  • GET
  • CONNECT
  • OPTIONS
  • PUT
  • PATCH
GET
namestring

The operation name.

GetUserInfo
pathstring

The operation path.

/user
descriptionstring

The operation description.

This is a operation description.
responseHttpApiResponseContract

The response parameters of the operation.

requestHttpApiRequestContract

The request parameters of the operation.

mockHttpApiMockContract

The mocking configuration of the operation. This field takes effect only when the API publishing scenario is Mock.

enableAuthboolean

Specifies whether to enable authentication.

true
authConfigAuthConfig

The authentication configurations.

deployConfigsarray

The deployment configurations.

HttpApiDeployConfig

object