提问人:G. Jonathan 提问时间:9/12/2023 更新时间:9/12/2023 访问量:95
API 响应模型的命名约定
Naming convention for the response model of an API
问:
对于一个 REST API,我必须向响应模型进行描述。它是一个简单的 Get API,从底层系统获取不同的数据。我正在使用骆驼案例 有很多不言自明的数据,如通常的姓氏、名字等...... 我正在使用显式结尾来定义检索到的数据,例如 wordWordDate 和 wordWordAmount。 如果它正在检索一个需要解释的值,我想知道我是否也应该使用一个特定的结尾,这意味着该值是一个代码,它具有特定的含义。
现在,部分响应是列表,有些只是固定属性。我想知道是否表明这是一个列表是否有意义。
对于代码,我使用了wordWordCode 对于列表,我使用了wordWordInfos 对于属性,我使用了wordWordDetails 房子的典型反应是:
{
{"body":
{"roomInfos":
[{"identifier": "01", "name": "garage", "hasWindow": true, "squareMeter": 20},
{"identifier": "02", "name": "kitchen", "hasWindow": true, "squareMeter": 15}
]
}
{"featureDetails":
{"squareMeter": 100, "faceCount": 3, "hasYard": true}
}
}
}
我怀疑这种命名约定是否合适。我希望它毫不含糊和清晰。然而,在这个例子中,我会将 roomInfos 替换为 rooms,复数形式以使其具有列表。 然而,房子的特点也不止1,有表面、面数和院子布尔。因此,我也倾向于将 featureDetails 替换为 features,复数形式。 这样做会很难确定这是否是一个列表。也许我想多了,并通过数据类型自动解决了这个问题,但我也想在文档中明确说明。
任何帮助或对最佳实践的外部参考都会有很大帮助。
答: 暂无答案
评论