NEIAPI / nei-toolkit

NEI 接口文档管理平台配套自动化工具
https://nei.netease.com
MIT License
812 stars 123 forks source link

已创建的接口选择从JSON导入请求/响应参数字段的疑问 #141

Open Fogram-z opened 3 years ago

Fogram-z commented 3 years ago

我想请问一下,新建数据模型的时候,选择从JSON文件导入可以解析到描述、标签等一些信息,那对于已经创建的接口,选择从JSON导入请求/响应参数的时候,也可以一并导入描述、必需、生成规则这些信息吗?可以的话JSON内容结构是怎样的?还是说接口参数只能导入名称和默认值,其他属性必须手动填写补充?谢谢!

在NEI 接口管理平台上支持导入 JSON格式的数据模型,格式如下: [ { "name": "数据模型的名称", "format": "数据模型的类别, 值是整数,比如 0 表示哈希,见下文解释", "description": "数据模型的描述", "tag": "数据模型的标签,多个标签以逗号分隔", "params": [ { "name": "字段的名称", "typeName": "字段的类型名称,见下文的说明", "description": "字段的描述", "defaultValue": "字段的默认值", "genExpression": "字段的生成规则", "isArray": "字段是否为数组, 值是整数,1 表示是,0 表示否" } ] } ] `

huntbao commented 3 years ago

对于已经创建的接口,目前不支持更新

Fogram-z commented 3 years ago

对于已经创建的接口,目前不支持更新

感谢您的解答,但是可能是我没问清楚,我想问的是点击【新建接口】按钮后,对新建的接口在录入参数的时候选择从JSON导入的时候,要传递怎样格式的JSON字串才能把参数名、默认值以外的信息一并录入,比如描述、必需、生成规则等信息。 不过对于该问题,目前已经通过自行编码解决了。

huntbao commented 3 years ago

对于已经创建的接口,目前不支持更新

感谢您的解答,但是可能是我没问清楚,我想问的是点击【新建接口】按钮后,对新建的接口在录入参数的时候选择从JSON导入的时候,要传递怎样格式的JSON字串才能把参数名、默认值以外的信息一并录入,比如描述、必需、生成规则等信息。 不过对于该问题,目前已经通过自行编码解决了。

导入数据格式说明:https://github.com/x-orpheus/nei-toolkit/blob/master/doc/NEI%E5%AF%BC%E5%85%A5HTTP%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8%E6%94%AF%E6%8C%81%E7%9A%84%E6%95%B0%E6%8D%AE%E6%A0%BC%E5%BC%8F.md