创建路由 - 云原生网关

请求参数

Authorization

Body 参数application/json

路由创建参数

apiCode

string

所属API编码

可选

description

string

路由描述

可选

hostCodes

array[string]

域名编码

可选

instanceCode

string

实例编码

可选

match

object (匹配条件)

可选

array[object (Predicate) {3}]

可选

请求参数（Cookie）匹配，区分大小写

headers

array[object (Predicate) {3}]

可选

请求头（Header）匹配

methods

array[string]

可选

HTTP方法，为空表示包含所有方法

示例值:

["GET","PUT"]

priority

integer <int32>

优先级，默认值为0

可选

>= 0<= 9223372036854776000

示例值:

queryParams

array[object (Predicate) {3}]

可选

请求参数（Query）匹配

routeTagNormalize

object (RouteTagNormalizeDTO)

可选

name

string

必需

路由名称，创建后无法修改

示例值:

test

正则匹配:

^(?![-_.])[a-zA-Z0-9-_.]{1,64}(?<![-_.])$

path

object (PathRuleDTO)

可选

type

string

路径匹配类型

必需

value

string

路径

必需

示例值:

/hello

正则匹配:

^/.{0,4095}$

resourceCreator

string

可选

资源创建者，默认值：console，管理台

upstreamConfig

object (UpstreamConfigRequest)

可选

dubboProxy

object (DubboProxyStrategyDTO)

Dubbo

可选

mock

object (MockStrategyDTO)

可选

redirect

object (RedirectStrategyDTO)

可选

scene

string

使用场景

可选

upstreams

array[object (DestinationUpstreamRequest) {4}]

后端服务配置

可选

示例

{
    "apiCode": "string",
    "description": "string",
    "hostCodes": [
        "string"
    ],
    "instanceCode": "string",
    "match": {
        "cookies": [
            {
                "key": "num",
                "type": "==",
                "value": 100
            }
        ],
        "headers": [
            {
                "key": "num",
                "type": "==",
                "value": 100
            }
        ],
        "methods": [
            "GET",
            "PUT"
        ],
        "priority": 0,
        "queryParams": [
            {
                "key": "num",
                "type": "==",
                "value": 100
            }
        ],
        "routeTagNormalize": {
            "hashFlag": false,
            "moduloOperationValue": 100,
            "paramLocation": "header",
            "paramName": "id",
            "routeTagNormalizedFlag": true,
            "tagExactValues": [
                1001,
                1002
            ],
            "tagRangeValueList": [
                {
                    "includeMax": true,
                    "includeMin": true,
                    "max": 0,
                    "min": 0
                }
            ],
            "tagType": "exact"
        }
    },
    "name": "test",
    "path": {
        "type": "string",
        "value": "/hello"
    },
    "resourceCreator": "string",
    "upstreamConfig": {
        "dubboProxy": {
            "method": "dubboMethod",
            "serviceName": "com.test.a.dubbo.service",
            "serviceVersion": "0.0.0"
        },
        "mock": {
            "code": 200,
            "responseJson": "{\"num\":100}"
        },
        "redirect": {
            "code": 301,
            "uri": "/redirect/path"
        },
        "scene": "string",
        "upstreams": [
            {
                "upstreamCode": "string",
                "versionCode": "string",
                "versionName": "v2",
                "weight": 10
            }
        ]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://m1.apifoxmock.com/m1/2270273-0-default/agw/v1/api-route/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiCode": "string",
    "description": "string",
    "hostCodes": [
        "string"
    ],
    "instanceCode": "string",
    "match": {
        "cookies": [
            {
                "key": "num",
                "type": "==",
                "value": 100
            }
        ],
        "headers": [
            {
                "key": "num",
                "type": "==",
                "value": 100
            }
        ],
        "methods": [
            "GET",
            "PUT"
        ],
        "priority": 0,
        "queryParams": [
            {
                "key": "num",
                "type": "==",
                "value": 100
            }
        ],
        "routeTagNormalize": {
            "hashFlag": false,
            "moduloOperationValue": 100,
            "paramLocation": "header",
            "paramName": "id",
            "routeTagNormalizedFlag": true,
            "tagExactValues": [
                1001,
                1002
            ],
            "tagRangeValueList": [
                {
                    "includeMax": true,
                    "includeMin": true,
                    "max": 0,
                    "min": 0
                }
            ],
            "tagType": "exact"
        }
    },
    "name": "test",
    "path": {
        "type": "string",
        "value": "/hello"
    },
    "resourceCreator": "string",
    "upstreamConfig": {
        "dubboProxy": {
            "method": "dubboMethod",
            "serviceName": "com.test.a.dubbo.service",
            "serviceVersion": "0.0.0"
        },
        "mock": {
            "code": 200,
            "responseJson": "{\"num\":100}"
        },
        "redirect": {
            "code": 301,
            "uri": "/redirect/path"
        },
        "scene": "string",
        "upstreams": [
            {
                "upstreamCode": "string",
                "versionCode": "string",
                "versionName": "v2",
                "weight": 10
            }
        ]
    }
}'

返回响应

🟢200成功

*/*

Body

OpenApi响应体

error

string

错误码

可选

示例值:

AGW_1000

message

string

API调用结果

可选

示例值:

success

requestId

string

请求唯一id

可选

示例值:

7a2828074ef6e32e041a2ef124b19e63

returnObj

object (CreateRouteResponseDTO)

可选

routeCode

string

可选

statusCode

integer <int32>

接口状态码

可选

示例值:

2000

示例

{
    "error": "AGW_1000",
    "message": "success",
    "requestId": "7a2828074ef6e32e041a2ef124b19e63",
    "returnObj": {
        "routeCode": "string"
    },
    "statusCode": 2000
}

🟢201成功

🟠401没有权限

🟠403禁止访问

🟠404记录不存在