阿拉星球 / 后台接口 / 保存生成代码文件

保存生成代码文件

接口描述: 根据传参,生成代码文件

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
id整型必须-要生成的接口设计id
is_force整型可选1文件存在是否强制覆盖,1表示不覆盖,2表示覆盖
is_data_api整型可选1是否生成数据接口API,同时创建数据库表,1是0否

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.isCreatebool是否创建成功,true表示创建成功,false表示创建失败
data.msg字符串创建信息
data.exampleMsg字符串创建示例信息
data.docs字符串接口文档地址
data.isExists字符串接口文件是否存在
data.isCreateExamplebool接口示例是否创建成功
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
id 必须
is_force 可选
is_data_api 可选

客户端请求示例

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

错误列表

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

本文档生成时间:2020-11-30 00:09:27