【FORGUNCY-19004\FORGUNCY-20228】服务端命令参数优化建议

登录

本帖最后由 Patrick.Zhu 于 2024-2-1 17:17 编辑

服务端命令在越来越多的场景里，是充当对外标准API来使用的
一般我们都会编写标准的API接口文档，供三方作为使用。

这也是项目对接的常见场景。

但服务端命令有几个不足的细节，会直接影响了它作为一个API对外提供服务。

1、参数结构定义只能1层
例如：我们只能定义一层参数类型，无法深入定义下一层，这样的话就会失去校验功能、命令内的提示等。

实际场景，参数不会那么简单，会有一些完整结构

2、无法设置“可选参数”
例如：我定义了一个data参数，不提供会导致报错。这个就应该是个bug了，毕竟从来没有哪个API是没有可选参数的。
希望能够解决这个问题之外，还有个过分的想法，能否实现“条件可选”，比如参数1和参数2必须提供其中一个。。。

moer · moer

Patrick.Zhu · Patrick.Zhu

第一个问题，我理解主要问题在于现在直接收JSON，需要自己拆，很麻烦？
第二个问题，超哥你之前提过，需求编号：FORGUNCY-19004

phoben · phoben

Patrick.Zhu 发表于 2024-1-29 17:50
第一个问题，我理解主要问题在于现在直接收JSON，需要自己拆，很麻烦？
第二个问题，超哥你之前提过，需求 ...

自己拆可以，我上面提到了就是会失去活字格的校验和内部提示

Patrick.Zhu · Patrick.Zhu

能多聊下这个JSON结构吗？你的意思是，JSON里面的每一项，可能都需要设置数据验证？希望多点背景分享

phoben · phoben

Patrick.Zhu 发表于 2024-1-30 17:42
能多聊下这个JSON结构吗？你的意思是，JSON里面的每一项，可能都需要设置数据验证？希望多点背景分享

对的，上面那个截图就是真实场景的，我向外开放 api 接口，只能通过服务端命令，而对入参的定义如果只有一层，会导致我命令内部要做大量逻辑来验证参数是否合法，如果参数本身就支持多层嵌套，并且支持数据校验，那就解决了这个问题

Patrick.Zhu · Patrick.Zhu

感谢超哥的补充，需求已记录，需求编号是：FORGUNCY-20228，有任何进展我会第一时间回复。

		自动登录	找回密码
密码			立即注册

[已采纳] 【FORGUNCY-19004\FORGUNCY-20228】服务端命令参数优化建议

本帖子中包含更多资源

评分

6 个回复

评分

时代开发者征文活动

微信认证勋章

悬赏达人

讲师达人

活字格认证

活字格高级认证