添加接口设计 - Admin.ApiDesign.AddApiDesign - APIUSB

接口地址：https://api.apiusb.com/api/admin?s=Admin.ApiDesign.AddApiDesign

接口描述：添加接口设计

HTTP/HTTPS

请求协议

GET/POST

请求方式

UTF-8

编码格式

JSON

返回格式

接口参数

参数名字	类型	是否必须	默认值	其他	说明
access_token	字符串	可选			访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口
api_name	字符串	必须	-	最大：100	接口服务名称，必须以App开头
api_modules	字符串	必须	-		接口模块名称
api_title	字符串	必须	-		接口服务名称
api_desc	字符串	必须	-		接口服务描述
api_request_params	字符串	可选	-		接口请求参数规则：所有的参数传递json字符串，请求的参数key分别对应：name:参数名称(英文), type:类型, desc:参数说明, require:必须(true或者false), default:默认值, max:最大值, min:最小值。当为空时填null。示例: [{"name":"yesapi","type":"string","require":true,"default":"phalapi","min":1,"max":100,"desc":"描述"},{"name":"age","type":"int","require":false,"default":"1","min":0,"max":100,"desc":"年龄"}] 更多详细规则参考：接口参数规则
api_response_params	字符串	可选	-		接口返回参数规则：所有的参数传递json字符串，请求的参数key分别对应： name:返回字段名称(英文), type:返回字段类型, desc:返回字段说明。 type的值可能为string，int，float，bool，array，object，date 示例: [{"name":"yesapi","type":"string","desc":"描述"},{"name":"age","type":"int","desc":"年龄"}]
api_response_example	字符串	可选	-		接口返回示例(json)

返回字段

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

在线测试

客户端请求示例

# 暂无示例，可添加示例文件：./src/view/docs/demos/Admin.ApiDesign.AddApiDesign.json

错误列表

本文档生成时间：2024-04-19 21:07:29