创建工具-j9九游会登录

authorization

是

string

参数解释：

鉴权信息。获取平台api key，并为api key添加前缀bearer，得到标准鉴权信息，例如bearer sk-74e4157***。api key获取方法请参见创建api key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

icon

是

string

参数解释：

工具图标的base64编码。

约束限制：

不涉及。

swagger

是

swagger object

参数解释：

工具对应的api信息。

约束限制：

不涉及。

auth_content

是

auth_content object

参数解释：

认证方式。目前支持基本认证、api key、iam、ak/sk、自定义、无验证。其中，自定义认证方式不填写此字段。

约束限制：

不涉及。

swagger

是

string

参数解释：

api信息使用swagger格式的版本。

约束限制：

填写2.0。

info

是

info object

参数解释：

工具的基本信息

约束限制：

不涉及。

schemas

是

array of strings

参数解释：

工具对应的api使用的协议。

约束限制：

填写http或https。

host

是

string

参数解释：

工具对应的api的主机地址。

约束限制：

格式正确的ip或域名。

basepath

是

string

参数解释：

工具对应的api的基准url，即域名的根路径。

约束限制：

必须以/开头，且不能有连续多个/，不包含除/._-以外的特殊字符和空格。

securitydefinitions

否

object

参数解释：

工具对应的api的验证方式，目前支持基本认证、api key、iam、ak/sk、自定义、无验证。使用基本认证、api key、无验证方式认证时填写此字段。

它们分别对应的json格式分别为：

1.基本认证：

{

"basicauth": {

"type": "basic"

}

}

2.api key：

{

"apikeyauth": {

"type": "apikey",

"in": "header",

"name": "x-api-key"

}

}

其中，in可以为header或query，name为用户填入的参数名称。

3.无验证：

{}

约束限制：

不涉及。

security

否

array of objects

参数解释：

工具对应的api的验证方式。

约束限制：

不涉及。

x-hw-securitydefinitions

否

object

参数解释：

工具对应的api的验证方式，目前支持基本认证、api key、iam、ak/sk、自定义、无验证。使用iam、ak/sk、自定义、无验证方式认证时填写此字段。

它们分别对应的json格式分别为：

1.iam：

{

"iam": {

"type": "iam"

}

}

2.ak/sk：

{

"aksk": {

"type": "aksk"

}

}

3.自定义：

{

"custom_auth": {

"type": "custom_auth",

"const": {

"authorization": {

"label": "authorization",

"required": true,

"type": "string",

"value": null,

"x-hw-visibility": null,

"format": null,

"description": "description"

}

},

"authparams": {

"authorization": {

"source": "const",

"sourcekey": "authorization",

"position": "header"

}

},

"flow": {}

}

}

其中，authorization是自定义入参的参数名称，required表示是否必填，type为参数类型，description为参数描述，position可以为header、body、query，format为"password"时，表示值加密，null表示非加密。

约束限制：

不涉及。

x-hw-security

否

array of objects

参数解释：

工具对应的api的验证方式。

约束限制：

不涉及。

version

是

string

参数解释：

工具版本。

约束限制：

填写1.0.0。

title

是

string

参数解释：

工具名称。

约束限制：

只能由中英文、数字、下划线、中划线、英文小括号组成，只能使用中英文以及数字开头，且长度不能超过32个字符。

description

是

string

参数解释：

工具描述。

约束限制：

只能包含中英文、数字、下划线、中划线、空格及,.?:;"'：；“”‘’，。？、（）()/@!！*%#等，且长度不能超过256个字符。

x-can-modify-host-address

是

boolean

参数解释：

工具的host是否可更改。

约束限制：

填写true或false。

auth_type

否

string

参数解释：

认证方式。目前支持基本认证、api key、iam、ak/sk、无验证。其中，基本认证、api key、iam、ak/sk、无验证分别填写basic、apikey、iam、aksk、none。

约束限制：

不涉及。

auth_info

否

object

参数解释：

认证方式。目前支持基本认证、api key、iam、ak/sk、自定义、无验证。其中：

1.基本认证填写：{}

2.api key填写：{}

3.iam填写：{}

4.ak/sk填写：{}

5.无验证填写：{}

约束限制：

不涉及。

auth_config

否

object

参数解释：

认证方式。目前支持基本认证、api key、iam、ak/sk、无验证。其中：

1.基本认证填写：{}

2.api key填写：{

"in": "header",

"name": "x-api-key"

}

3.iam填写：{}

4.ak/sk填写：{}

5.无验证填写：{}

约束限制：

不涉及。

auth_prop

否

object

参数解释：

认证方式。目前支持基本认证、api key、iam、ak/sk、无验证。其中：

1.基本认证填写：{}

2.api key填写：{}

3.iam填写：{}

4.ak/sk填写：{}

5.无验证填写：{}

约束限制：

不涉及。

auth_dynamic

否

object

参数解释：

认证方式。目前支持基本认证、api key、iam、ak/sk、自定义、无验证。其中：

1.基本认证填写：{}

2.api key填写：{}

3.iam填写：{}

4.ak/sk填写：{}

5.无验证填写：{}

约束限制：

不涉及。

-

string

参数解释：

创建出的工具的id。

约束限制：

不涉及。

error_code

string

参数解释：

错误码。

取值范围：

不涉及。

error_msg

string

参数解释：

错误信息。

取值范围：

不涉及。

200

成功。

500

服务器内部错误或三方服务器内部错误。