有人知道绘制方法输入数据的精确结构的好方法吗?就我而言,我必须为服务器应用程序指定正确的输入数据。服务器获取包含数据的 http post。因为这个数据是一个非常复杂的json数据结构,所以我想把它画出来,这样接下来的开发人员就可以很容易地检查绘图并能够理解,http post需要什么数据。如果我还可以绘制 http header ,将数据标记为强制或最好拥有,那就太好了。
我不需要数据流程图或其他东西。像那样。我需要的是一张图,如何为服务器方法构建有效的 json。
如果有人有想法,请回答或评论这个问题,即使您只是有流行词的想法,我也可以自己用谷歌搜索。
最佳答案
为了描述数据结构,请考虑使用 UML class diagram (1)具有多样性和所有权以及“命名关联结束”。 Kirill Fakhroutdinov 的示例 uml-diagrams.org: Online Shopping和 uml-diagrams.org: Sentinel HASP Licensing Domain说明您的绘图可能是什么样子。
由于您需要具体描述 json
结构,然后(2) Google:“json schema”以查看其他人如何解决相同问题。
就个人而言,除了提供 UML 图之外,我还(3)考虑编写 TypeScript definition file它实际上可以描述 json
结构,包括简单类型、嵌套结构、可选部分等。此外,下一个开发人员可以通过编写简单的 TypeScript 来根据定义验证数据结构示例(单元测试)
脚本并尝试编译它
关于json - 应用程序输入规范: Drawing input data of method,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/26545104/