showdoc icon indicating copy to clipboard operation
showdoc copied to clipboard

建议runapi的字段说明增加对象引用的功能

Open clip-tail opened this issue 5 months ago • 9 comments

接口开发中经常遇到一个对象参数在很多接口都使用的情况,我们现在一般都会另起一个文档去写这个对象的属性然后在字段说明里写上文档路径,但是如果是json格式的话点击快速生成每次都会把这个对象里的所有属性都列出来,可否出一个对象引用的功能,一个对象如果引用了另一个文档,就不把这个对象里的所有属性给列出来了

clip-tail avatar Aug 15 '25 02:08 clip-tail

最近有想搞一个通用描述库,每次生成可以参考这个描述库来简化输入。 比如说,描述库里 json.test 是 测试,那么下次识别就填充测试。 如果有了这种方便的填充工具,会方便一点。 然后,针对你的情况,如果你不想每个页面都写一遍,那也许可以新建一个markdown页面说明。然后参数那里就说明去参考那个页面就行。 目前 引用的交互,感觉非常麻烦,没想好怎么做。引用应该不好做

star7th avatar Aug 15 '25 02:08 star7th

我提供个思路您看是否有帮助哈,就是在字段说明的操作那一栏增加一个按钮,点击这个按钮之后展示项目的树形结构提供给用户选择,选择完之后字段描述那一栏就回填文档的路径,例如“通用模型\分页对象”,然后自动删除字段说明里这个对象名下所有属性行,就比如这个对象叫pageParam,那字段说明里所有”pageParam.“开头的行都去掉

clip-tail avatar Aug 15 '25 02:08 clip-tail

已经支持 参数描述库 ,请重新下载 https://www.runapi.com.cn/

star7th avatar Aug 28 '25 14:08 star7th

已经支持 参数描述库 ,请重新下载 https://www.runapi.com.cn/

能出个使用教程么,找了一圈不知道这功能怎么用

clip-tail avatar Sep 04 '25 06:09 clip-tail

Image 我找机会更新一下说明吧

star7th avatar Sep 04 '25 08:09 star7th

其实就是,你现在描述库里定义好字段信息。那么你下次点击 从示例中生成 按钮的时候,除了生成字段名,还会自动匹配并填写描述信息。这样不用重复填写。

star7th avatar Sep 04 '25 08:09 star7th

是要出个教程,我没找到描述库在哪新增的

clip-tail avatar Sep 04 '25 09:09 clip-tail

Image Image

star7th avatar Sep 04 '25 10:09 star7th

明白了

clip-tail avatar Sep 04 '25 10:09 clip-tail