如何记录可选的RESTful JSON API属性?

时间:2017-01-13 15:47:49

标签: json rest swagger api-design

我一直在试图弄清楚如何为我正在构建的API设计文档。我一直在使用Swagger(swagger.io)和JSONSchema来帮助我构建文档,但是我遇到了麻烦。我们的一些对象将有很多我们称之为“元数据”的东西,它们基本上是键/值的任意和可变字典。例如:

ToDictionary

因此,我可以通过枚举 all 元数据属性来记录对象表示,但列表很长,可能会随着时间的推移而变化。

是否有另一种方法来记录这个,或以不同的方式设计API?

0 个答案:

没有答案