有没有人知道一个很好的方法来绘制方法输入数据的精确结构?在我的例子中,我必须为服务器应用程序指定正确的输入数据。服务器使用数据获取一个http post。因为这个数据是一个非常复杂的json数据结构,所以我想画这个,这样下一个开发人员就可以很容易地检查这个图,并且能够理解http post需要什么数据。如果我还可以绘制http头,将数据标记为必需的或很好的。
我不需要数据流图之类的东西。我需要的是一个绘图,如何为服务器方法构建一个有效的json。
如果有人有想法,请回答或评论这个问题,即使你对流行语有想法,我也可以用谷歌搜索自己。
最佳答案
为了描述数据结构,考虑(1)使用具有多重性、所有权和“命名关联结束”的UML class diagram。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
脚本并尝试编译它来验证数据结构(单元测试)的示例。