查询接口 - 云原生网关

请求参数

Authorization

Query 参数

apiCode

string

所属API编码

必需

示例值:

333810512

interfaceCode

string

接口编码

必需

示例值:

728947

Header 参数

jwt

string

可选

默认值:

eyJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjE4MjA3NCwidGVuYW50SWQiOjk5NDg3MDcsInVzZXJOYW1lIjoiY3R5dW4wYTFjMzI1MmI2MjQ0NzEyMTcyNTQyMjU3MSIsInRlbmFudE5hbWUiOiJtc2FwX21zZV9jc21fZGV2X21hc3RlckBxcS5jb20jcGFhczQwIiwidGVuYW50Q29kZSI6IkN0eXVuM2UxNjIxYTY3YjQwNDY0MjE3MjU0MjI1NzEiLCJidXNpVXNlcklkIjpudWxsLCJidXNpVGVuYW50SWQiOm51bGwsImJ1c2lUZW5hbnROYW1lIjpudWxsLCJhY2NvdW50VHlwZSI6MCwiaXNPd25lciI6dHJ1ZSwicmVhbE5hbWUiOiJtc2FwX21zZV9jc21fZGV2IiwicmVxU291cmNlIjoiMDEiLCJ2ZXJzaW9uTm8iOiIzLjAuMCIsInJlc1Bvb2xDb2RlIjoiYjM0MmI3N2VmMjZiMTFlY2IwYWMwMjQyYWMxMTAwMDIiLCJwcml2YXRlS2V5IjpudWxsLCJvdXRlclRlbmFudElkIjoiM2UxNjIxYTY3YjQwNDY0MmIxMDAxMDc3YzcxYmE3OWYiLCJvdXRlclVzZXJJZCI6IjBhMWMzMjUyYjYyNDQ3MTJiNmNiM2FhMGU1YTc5M2JmIiwiYWdlbnRVc2VySWQiOm51bGwsImFnZW50VGVuYW50SWQiOm51bGwsImlhdCI6MTczMjUxOTQ3NCwiaXNzIjoiZmlyc3R6dXVsIiwiZXhwIjoyMzMyNTE5NDc0fQ.XiXnJQmUSVc8I-IVY99JE5VmHMvM8dydDpD9xC5St8g

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

*/*

Body

code

integer <int32>

响应编码

可选

示例值:

200

data

object (ApiInterfaceDTO)

API接口定义

可选

apiCode

string

所属API编码

可选

示例值:

321781684

code

string

接口编码

可选

示例值:

8231767

createTime

string <date-time>

创建时间

可选

description

string

描述

可选

示例值:

这是一个测试接口

isAuthorized

boolean

是否消费者授权

可选

示例值:

false

isPluginBind

boolean

是否绑定了插件

可选

示例值:

false

method

string

可选

HTTP方法，GET, POST, PUT, DELETE等

示例值:

GET

mock

object (MockDefinitionDTO)

Mock配置

可选

name

string

接口名称

可选

示例值:

api_test

path

string

路径

可选

示例值:

/test

request

object (RequestDefinitionDTO)

请求定义

可选

response

object (ResponseDefinitionDTO)

响应定义

可选

updateTime

string <date-time>

更新时间

可选

message

string

消息内容

可选

示例值:

success

requestId

string

请求唯一id

可选

示例值:

123456789-adc

示例

{
    "code": 200,
    "data": {
        "apiCode": 321781684,
        "code": 8231767,
        "createTime": "2019-08-24T14:15:22Z",
        "description": "这是一个测试接口",
        "isAuthorized": false,
        "isPluginBind": false,
        "method": "GET",
        "mock": {
            "enable": true,
            "responseCode": 200,
            "responseContent": "{\"num\":100}"
        },
        "name": "api_test",
        "path": "/test",
        "request": {
            "body": {
                "contentType": "application/json;charset=UTF-8",
                "example": {},
                "jsonSchema": {}
            },
            "headerParameters": [
                {
                    "defaultValue": "hello",
                    "description": "这是一个参数",
                    "exampleValue": "hello",
                    "name": "p1",
                    "required": true,
                    "type": "String"
                }
            ],
            "pathParameters": [
                {
                    "defaultValue": "hello",
                    "description": "这是一个参数",
                    "exampleValue": "hello",
                    "name": "p1",
                    "required": true,
                    "type": "String"
                }
            ],
            "queryParameters": [
                {
                    "defaultValue": "hello",
                    "description": "这是一个参数",
                    "exampleValue": "hello",
                    "name": "p1",
                    "required": true,
                    "type": "String"
                }
            ]
        },
        "response": {
            "contentType": "application/json;charset=utf-8",
            "items": [
                {
                    "code": 200,
                    "description": "成功",
                    "example": {},
                    "jsonSchema": {}
                }
            ]
        },
        "updateTime": "2019-08-24T14:15:22Z"
    },
    "message": "success",
    "requestId": "123456789-adc"
}

🟠401没有权限

🟠403禁止访问

🟠404记录不存在