c# - Api 文档和枚举语义

Question

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

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

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

尽管如此，假设您正在为其他程序员编写文档，而不仅仅是管理必须经历的事情，我认为枚举或枚举是好的，因为您的听众会很清楚，这就是您想要实现的目标。