HTTP/HTTPS
请求协议
接口地址:http://yesx2.com/api/admin.php?s=Admin.ApiDesign.AddApiDesign
接口描述: 添加接口设计
接口大师[旗舰版演示] / 后台接口 / 添加接口设计
添加接口设计
接口地址:http://yesx2.com/api/admin.php?s=Admin.ApiDesign.AddApiDesign
接口描述: 添加接口设计
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
api_namespace | 字符串 | 可选 | App | 最小:1 | 接口命名空间 |
api_name | 字符串 | 必须 | - | 最大:100 | 接口服务名称 |
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) | |
is_hide_doc | 整型 | 可选 | 0 | 是否隐藏接口文档,0否1是 | |
request_method | 字符串 | 可选 | 请求方式 | ||
is_data_api | 整型 | 可选 | 1 | 是否生成数据接口API,同时创建数据库表,1是0否 | |
api_code | 字符串 | 可选 | - | 完整的接口代码 | |
api_function_code | 字符串 | 可选 | - | 简易的接口函数代码 | |
api_dev_mode | 整型 | 可选 | 0 | API开发模式,0完整模式1简易模式 | |
database_id | 字符串 | 可选 | 0 | 数据库配置id | |
database_table_name | 字符串 | 可选 | 数据库对应的表名字 | ||
is_curd | 字符串 | 可选 | 0 | 是否使用CURD基类接口 | |
sql_detail | 字符串 | 可选 | sql语句 | ||
icon | 字符串 | 可选 | 接口图标 | ||
api_group | 字符串 | 可选 | 接口分组 | ||
upstream_api_url | 字符串 | 可选 | 上游网关地址 | ||
upstream_api_request_method | 字符串 | 可选 | 上游网关请求方式 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.code | bool | 是否添加成功,true表示添加成功,false添加失败 |
data.msg | 字符串 | 添加成功失败信息 |
data.id | 整型 | 添加成功的id |
data.addTime | 字符串 | 添加时间 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
api_namespace | 可选 | |
api_name | 必须 | |
api_modules | 必须 | |
api_title | 必须 | |
api_desc | 必须 | |
api_request_params | 可选 | |
api_response_params | 可选 | |
api_response_example | 可选 | |
is_hide_doc | 可选 | |
request_method | 可选 | |
is_data_api | 可选 | |
api_code | 可选 | |
api_function_code | 可选 | |
api_dev_mode | 可选 | |
database_id | 可选 | |
database_table_name | 可选 | |
is_curd | 可选 | |
sql_detail | 可选 | |
icon | 可选 | |
api_group | 可选 | |
upstream_api_url | 可选 | |
upstream_api_request_method | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.ApiDesign.AddApiDesign.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-19 22:27:23