文档
测试

接口注册

POST
/api/add

接口描述

接口注册。

请求参数

参数名
类型
描述
必填
app_id
int
应用id
必填
service_id
int
服务id
必填
api_name
string
接口英文名称
必填
api_title
string
接口中文标题
必填
api_desc
string
接口简介
必填
author
string
接口负责人
必填
url
string
接口地址
必填
method
string
接口请求方法
必填
api_params
string
接口参数json字符串,示例:[{"field_name":"fa","field_desc":"fa field","field_type":1,"default_val":0,"required":1}, {"field_name":"fb","field_desc":"fb field","field_type":2,"default_val":"abc","required":1}]
必填
field_name
string
字段名
必填
field_desc
string
字段描述
必填
field_type
string
字段类型枚举,int,string,float,array,object,array[int],array[string],array[float],array[object]
必填
default_val
string
默认值
必填
required
int
是否必填
必填
api_return_vals
string
接口返回值json字符串,示例:[{"field_name":"field_1","field_desc":"field 1 desc","field_type":1,"child_fields":[{"field_name":"field_1_child","field_desc":"field_1_child desc","field_type":2,"child_fields":[],"required":1}],"required":1},{"field_name":"field_2","field_desc":"field 1 desc","field_type":2,"child_fields":[],"required":1}]
必填
field_name
string
字段名
必填
field_desc
string
字段描述
必填
field_type
string
字段类型枚举,int,string,float,array,object,array[int],array[string],array[float],array[object]
必填
child_fields
array
子字段定义
必填

响应参数

参数名
类型
描述
必填
code
int
状态码,0为成功,其他为错误
必填
msg
string
错误信息
必填
data
object
数据字典
必填
service_id
string
服务id
必填
api_name
string
接口英文名称
必填
api_desc
string
接口简介
必填
api_title
string
接口中文标题
必填
author
string
接口负责人
必填
url
string
接口地址
必填
method
string
接口请求防范
必填
app_id
string
应用id
必填
id
int
接口id
必填