Api文档和枚举语义

Question

我正在为我的REST Web服务创建API文档。请求和响应包含一些枚举，但是描述这些内容的好部分标题是什么。标题“Enumerations”听起来是为了编程，我错了吗？

Gender

Male - 1
Female - 2

Pool Team Status

All - 1
Active - 2
Active and Paid - 3

Registration Status

All - 1
Active - 2
Active and Paid - 3

Status

All - 1
Active - 2
Active and Paid - 3

Answer 1

您可以将它们称为选项，替代品或任何其他同义词（如果它们是这样的话）。

尽管如此，假设您正在为其他程序员编写文档，而不仅仅是管理层必须经历的文档，我认为Enumerations或Enums是好的，因为它会让您的受众清楚，这是您想要实现的目标