Apis

API Management - Central registry for maintaining interface debug value, schema definitions, and version history

---

Query the basic information of api

GET

/api/v1/apis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Apis id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

serviceId

Services id

类型integer

format"int64"

protocol

类型string

枚举

"http""https""ws""wss"

method

类型string

枚举

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

summary

类型string

operationId

类型string

status

类型string

枚举

"UNKNOWN""IN_DESIGN""IN_DEV""DEV_COMPLETED""RELEASED"

admin

Required when app administrators query all apis

类型boolean

hasPermission

Required when the user query has the one permission apis

类型string

枚举

"VIEW""MODIFY""DELETE""DEBUG""TEST""GRANT""SHARE""RELEASE""EXPORT"

endpoint

类型string

ownerId

类型integer

format"int64"

createdDate

类型string

format"date-time"

createdBy

类型integer

format"int64"

favouriteBy

类型integer

format"int64"

followBy

类型integer

format"int64"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

serviceId

protocol

method

summary

operationId

status

admin

hasPermission

endpoint

ownerId

createdDate

createdBy

favouriteBy

followBy

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Replace api

PUT

/api/v1/apis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"id": 0,

"unarchivedId": 0,

"serviceId": 0,

"protocol": "http",

"method": "GET",

"endpoint": "/comm/api/v1/country/{id}",

"tags": [

"string"

],

"summary": "Add user api",

"description": "string",

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"operationId": "string",

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"requestBody": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"responses": {

"additionalProperties": {

}

},

"deprecated": true,

"security": [

{

"empty": true,

"additionalProperties": [

]

}

],

"currentServer": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"authentication": {

"type": "string",

"description": "string",

"name": "string",

"get$ref": "string",

"in": "string",

"scheme": "string",

"bearerFormat": "string",

"flows": {

"implicit": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"password": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"clientCredentials": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"authorizationCode": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"extensions": {

"additionalProperties": {

}

}

},

"openIdConnectUrl": "string",

"extensions": {

"additionalProperties": {

}

}

},

"assertions": [

{

"name": "Assertion status",

"description": "Assertion response status must is 200.",

"enabled": true,

"type": "BODY",

"parameterName": "string",

"condition": "string",

"assertionCondition": "EQUAL",

"expression": "string",

"matchItem": 0,

"expected": 200,

"extraction": {

"name": "string",

"method": "string",

"expression": "string",

"matchItem": 0,

"defaultValue": "string",

"request": {

"method": "GET",

"url": "string",

"server": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"endpoint": "string",

"authentication": {

"type": "string",

"in": "string",

"scheme": "string",

"name": "string",

"description": "string",

"enabled": "true",

"value": "string",

"apiKeys": [

{

"name": "Authorization",

"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",

"x-xc-value": "string"

}

],

"oauth2": {

"clientCredentials": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"password": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"authFlow": "string",

"newToken": true,

"token": "string"

}

},

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"body": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"validSecurity": true

},

"location": "string",

"parameterName": "string",

"value": "string",

"finalValue": "string",

"failureMessage": "string"

},

"actualCondition": "string",

"actualExpected": "string",

"extractValue": "string",

"result": {

"failure": true,

"ignored": true,

"message": "string"

},

"success": true,

"enabledFlag": true,

"ignore": true

}

],

"auth": true,

"datasetActionOnEOF": "string",

"datasetSharingMode": "string",

"testFunc": true,

"testPerf": true,

"testStability": true,

"ownerId": 0,

"status": "DEV_COMPLETED",

"extensions": {

"additionalProperties": {

}

}

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete api

DELETE

/api/v1/apis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Api ids

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/apis

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Update api

PATCH

/api/v1/apis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"id": 0,

"protocol": "http",

"method": "GET",

"endpoint": "/comm/api/v1/country/{id}",

"tags": [

"string"

],

"summary": "Add user api",

"description": "string",

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"operationId": "string",

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"requestBody": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"responses": {

"additionalProperties": {

}

},

"deprecated": true,

"security": [

{

"empty": true,

"additionalProperties": [

]

}

],

"currentServer": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"authentication": {

"type": "string",

"description": "string",

"name": "string",

"get$ref": "string",

"in": "string",

"scheme": "string",

"bearerFormat": "string",

"flows": {

"implicit": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"password": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"clientCredentials": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"authorizationCode": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"extensions": {

"additionalProperties": {

}

}

},

"openIdConnectUrl": "string",

"extensions": {

"additionalProperties": {

}

}

},

"assertions": [

{

"name": "Assertion status",

"description": "Assertion response status must is 200.",

"enabled": true,

"type": "BODY",

"parameterName": "string",

"condition": "string",

"assertionCondition": "EQUAL",

"expression": "string",

"matchItem": 0,

"expected": 200,

"extraction": {

"name": "string",

"method": "string",

"expression": "string",

"matchItem": 0,

"defaultValue": "string",

"request": {

"method": "GET",

"url": "string",

"server": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"endpoint": "string",

"authentication": {

"type": "string",

"in": "string",

"scheme": "string",

"name": "string",

"description": "string",

"enabled": "true",

"value": "string",

"apiKeys": [

{

"name": "Authorization",

"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",

"x-xc-value": "string"

}

],

"oauth2": {

"clientCredentials": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"password": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"authFlow": "string",

"newToken": true,

"token": "string"

}

},

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"body": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"validSecurity": true

},

"location": "string",

"parameterName": "string",

"value": "string",

"finalValue": "string",

"failureMessage": "string"

},

"actualCondition": "string",

"actualExpected": "string",

"extractValue": "string",

"result": {

"failure": true,

"ignored": true,

"message": "string"

},

"success": true,

"enabledFlag": true,

"ignore": true

}

],

"datasetActionOnEOF": "string",

"datasetSharingMode": "string",

"testFunc": true,

"testPerf": true,

"testStability": true,

"ownerId": 1,

"status": "string",

"extensions": {

"additionalProperties": {

}

}

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/apis

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the server configuration of api

GET

/api/v1/apis/{id}/schema/server

Note: The data source includes the current api request server, servers configuration, and parent services servers configuration

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/{id}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Replace server configuration of the api

PUT

/api/v1/apis/{id}/schema/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

请求体

application/json

{

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/{id}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

Delete servers of the api

DELETE

/api/v1/apis/{id}/schema/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

查询参数

urls*

Server url

类型array

必填

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/apis/{id}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

id*

urls*

示例

cURL

JavaScript

PHP

Python

---

Replace all server configuration of the api

PUT

/api/v1/apis/{id}/schema/server/all

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

请求体

application/json

[

{

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/{id}/schema/server/all

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

Update the name of api

PUT

/api/v1/apis/{id}/name

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

查询参数

name*

New apis name

类型string

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/{id}/name

试验场

授权

UserHttpBearer

变量

键

值

id*

name*

示例

cURL

JavaScript

PHP

Python

---

Archive the unarchived api

PUT

/api/v1/apis/archive

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"unarchivedId": 0,

"serviceId": 0,

"protocol": "http",

"method": "GET",

"endpoint": "/comm/api/v1/country/{id}",

"summary": "Add user api",

"description": "string",

"operationId": "string",

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"requestBody": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"responses": {

"additionalProperties": {

}

},

"currentServer": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"authentication": {

"type": "string",

"description": "string",

"name": "string",

"get$ref": "string",

"in": "string",

"scheme": "string",

"bearerFormat": "string",

"flows": {

"implicit": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"password": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"clientCredentials": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"authorizationCode": {

"authorizationUrl": "string",

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"extensions": {

"additionalProperties": {

}

}

},

"openIdConnectUrl": "string",

"extensions": {

"additionalProperties": {

}

}

},

"assertions": [

{

"name": "Assertion status",

"description": "Assertion response status must is 200.",

"enabled": true,

"type": "BODY",

"parameterName": "string",

"condition": "string",

"assertionCondition": "EQUAL",

"expression": "string",

"matchItem": 0,

"expected": 200,

"extraction": {

"name": "string",

"method": "string",

"expression": "string",

"matchItem": 0,

"defaultValue": "string",

"request": {

"method": "GET",

"url": "string",

"server": {

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

},

"endpoint": "string",

"authentication": {

"type": "string",

"in": "string",

"scheme": "string",

"name": "string",

"description": "string",

"enabled": "true",

"value": "string",

"apiKeys": [

{

"name": "Authorization",

"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",

"x-xc-value": "string"

}

],

"oauth2": {

"clientCredentials": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"password": {

"tokenUrl": "string",

"refreshUrl": "string",

"scopes": [

"string"

],

"clientId": "string",

"clientSecret": "string",

"clientIn": "string",

"username": "string",

"password": "string"

},

"authFlow": "string",

"newToken": true,

"token": "string"

}

},

"parameters": [

{

"name": "string",

"in": "string",

"description": "string",

"required": true,

"deprecated": true,

"allowEmptyValue": true,

"get$ref": "string",

"style": "string",

"explode": true,

"allowReserved": true,

"schema": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": {

"type": [

"string"

],

"format": "string",

"if": "[Circular Reference]",

"then": "[Circular Reference]",

"else": "[Circular Reference]",

"get$anchor": "string",

"get$comment": "string",

"get$dynamicAnchor": "string",

"get$id": "string",

"get$ref": "string",

"get$schema": "string",

"get$vocabulary": "string",

"additionalItems": "[Circular Reference]",

"additionalProperties": {

},

"allOf": [

{

}

],

"anyOf": [

{

}

],

"const": {

},

"contains": "[Circular Reference]",

"contentEncoding": "string",

"contentMediaType": "string",

"contentSchema": "[Circular Reference]",

"default": {

},

"dependentRequired": {

"additionalProperties": [

]

},

"dependentSchemas": {

"additionalProperties": {

}

},

"deprecated": true,

"description": "string",

"discriminator": {

"propertyName": "string",

"mapping": {

"additionalProperties": "string"

},

"extensions": {

"additionalProperties": {

}

}

},

"enum": [

{

}

],

"example": {

},

"examples": [

{

}

],

"exclusiveMaximum": 0,

"exclusiveMinimum": 0,

"extensions": {

"additionalProperties": {

}

},

"externalDocs": {

"description": "Find more info here",

"url": "https://example.com",

"extensions": {

"additionalProperties": {

}

}

},

"items": "[Circular Reference]",

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"maxContains": 0,

"maxItems": 0,

"maxLength": 0,

"maxProperties": 0,

"maximum": 0,

"minContains": 0,

"minItems": 0,

"minLength": 0,

"minProperties": 0,

"minimum": 0,

"multipleOf": 0,

"not": "[Circular Reference]",

"oneOf": [

{

}

],

"pattern": "string",

"patternProperties": {

"additionalProperties": {

}

},

"prefixItems": [

{

}

],

"properties": {

"additionalProperties": {

}

},

"propertyNames": "[Circular Reference]",

"readOnly": true,

"required": [

"string"

],

"title": "string",

"unevaluatedItems": "[Circular Reference]",

"unevaluatedProperties": "[Circular Reference]",

"uniqueItems": true,

"writeOnly": true,

"xml": {

"name": "string",

"namespace": "string",

"prefix": "string",

"attribute": true,

"wrapped": true,

"extensions": {

"additionalProperties": {

}

}

}

},

"examples": {

"additionalProperties": {

}

},

"example": {

},

"content": {

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

}

}

],

"body": {

"format": "string",

"contentEncoding": "string",

"forms": [

{

"name": "string",

"description": "string",

"enabled": "true",

"type": "string",

"format": "string",

"contentType": "string",

"contentEncoding": "string",

"value": "string",

"fileName": "string",

"x-xc-value": "string",

"x-xc-contentEncoding": "string",

"x-xc-contentType": "string",

"x-xc-fileName": "string"

}

],

"rawContent": "string",

"fileName": "string"

},

"validSecurity": true

},

"location": "string",

"parameterName": "string",

"value": "string",

"finalValue": "string",

"failureMessage": "string"

},

"actualCondition": "string",

"actualExpected": "string",

"extractValue": "string",

"result": {

"failure": true,

"ignored": true,

"message": "string"

},

"success": true,

"enabledFlag": true,

"ignore": true

}

],

"auth": true,

"datasetActionOnEOF": "string",

"datasetSharingMode": "string",

"testFunc": true,

"testPerf": true,

"testStability": true,

"ownerId": 0,

"status": "DEV_COMPLETED",

"extensions": {

"additionalProperties": {

}

}

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/archive

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Clone api

POST

/api/v1/apis/{id}/clone

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/apis/{id}/clone

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query the mock apis information associated with the api

GET

/api/v1/apis/{id}/association/mock/apis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/{id}/association/mock/apis

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Add mock api association

POST

/api/v1/apis/{id}/association/mock/apis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

请求体

application/json

{

"mockServiceId": 0,

"summary": "This is mock apis name"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/apis/{id}/association/mock/apis

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

Modify api status

PATCH

/api/v1/apis/{id}/status

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

查询参数

status*

Api status

类型string

必填

枚举

"UNKNOWN""IN_DESIGN""IN_DEV""DEV_COMPLETED""RELEASED"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/apis/{id}/status

试验场

授权

UserHttpBearer

变量

键

值

id*

status*

示例

cURL

JavaScript

PHP

Python

---

Move the api to another service

PATCH

/api/v1/apis/move

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"apiIds": [

0

],

"targetServiceId": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/apis/move

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of api

GET

/api/v1/apis/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

查询参数

resolveRef*

Resolve reference flag, default false

类型boolean

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

resolveRef*

示例

cURL

JavaScript

PHP

Python

---

Query the OpenAPI document of api

GET

/api/v1/apis/{id}/openapi

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

查询参数

format

OpenAPI document format. Available values yaml or json, the default value is yaml

类型string

枚举

"yaml""json""yaml, json"

示例"yaml"

gzipCompression

Whether to turn on Gzip compression. It is recommended to enable gzip compression. After enabling it, the data size can be reduced by more than 20 times. By default, gzip compression is enabled

类型boolean

示例true

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/{id}/openapi

试验场

授权

UserHttpBearer

变量

键

值

id*

format

gzipCompression

示例

cURL

JavaScript

PHP

Python

---

Export the OpenAPI specification of api

GET

/api/v1/apis/{id}/openapi/export

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

查询参数

format

OpenAPI document format. Available values yaml or json, the default value is yaml

类型string

枚举

"yaml""json""yaml, json"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/{id}/openapi/export

试验场

授权

UserHttpBearer

变量

键

值

id*

format

示例

cURL

JavaScript

PHP

Python

---

Check api

GET

/api/v1/apis/{id}/check

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Api id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/{id}/check

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the basic information of api

GET

/api/v1/apis/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Apis id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

serviceId

Services id

类型integer

format"int64"

protocol

类型string

枚举

"http""https""ws""wss"

method

类型string

枚举

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

summary

类型string

operationId

类型string

status

类型string

枚举

"UNKNOWN""IN_DESIGN""IN_DEV""DEV_COMPLETED""RELEASED"

admin

Required when app administrators query all apis

类型boolean

hasPermission

Required when the user query has the one permission apis

类型string

枚举

"VIEW""MODIFY""DELETE""DEBUG""TEST""GRANT""SHARE""RELEASE""EXPORT"

endpoint

类型string

ownerId

类型integer

format"int64"

createdDate

类型string

format"date-time"

createdBy

类型integer

format"int64"

favouriteBy

类型integer

format"int64"

followBy

类型integer

format"int64"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/search

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

serviceId

protocol

method

summary

operationId

status

admin

hasPermission

endpoint

ownerId

createdDate

createdBy

favouriteBy

followBy

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Query the detail list of api

GET

/api/v1/apis/list/detail

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Api ids

类型array

必填

maxItems200

minItems0

uniqueItemstrue

resolveRef*

Resolve reference flag, default false

类型boolean

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/list/detail

试验场

授权

UserHttpBearer

变量

键

值

ids*

resolveRef*

示例

cURL

JavaScript

PHP

Python

---