All Products
Search
Document Center

API Gateway:HttpApiRequestContract

Last Updated:Nov 12, 2025
ParameterTypeDescriptionExample
object

HttpApiRequestContract

headerParametersarray

The request header parameters.

HttpApiParameter

The parameter definition.

queryParametersarray

The query parameters.

HttpApiParameter

The parameter definition.

pathParametersarray

The path parameters.

HttpApiParameter

The parameter definition.

bodyobject

The body parameters.

descriptionstring

The parameter description.

This is a description.
examplestring

The sample value.

{"result":"ok"}
contentTypestring

The content type of the request body.

application/json
jsonSchemastring

The JSON definition description of the request body.

{ "type": "object", "required": [ "result" ], "properties": { "result": { "type": "string", "description": "Operation result. 'ok' indicates success." } } }