导入swagger配置到api

HTTP/HTTPS GET/POST UTF-8 JSON v1.0

接口地址:http://yesx2.com/api/admin.php?s=Admin.ApiDesign.ImportSwaggerToApi  

接口描述: 导入swagger配置到api

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
import_create_api_name字符串用,分割必须-最小:1要导入创建的api,多个用,分隔 注意,每个选择的接口后续用--拼接存在怎么处理(接口存在时:0直接跳过 10覆盖)--导入后怎么处理(导入后处理类型:0保存草稿 10保存草稿并发布)
import_swagger_key字符串必须-最小:1swaggerCacheKey
use_host字符串必须-最小:1使用域名
filefile可选-最大:2000000待导入是swagger配置文件

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
msg字符串提示信息,失败时的错误提示

在线测试   


参数是否必须
service 必须
access_token 可选
import_create_api_name 必须
import_swagger_key 必须
use_host 必须
file 可选

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.ApiDesign.ImportSwaggerToApi.json

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
409ret=409,接口流量不足
410ret=410,接口限流
500表示服务端内部错误

本文档生成时间:2024-04-28 22:48:50