Python Sphinx描述api的有效输入值

我一直在使用sphinx来记录我们的api。正如人们可能期望的那样，我们的api中有一些参数的值是受限的。例如，描述电视的帖子可能有一个“on”参数，同一个参数可能可用于GET上的过滤

我的问题是，我找不到一种内置的方法来描述有效的参数值。对于bools，我可以把它放在parens中，但是有些参数有20个有效的输入值，有些参数有多个可能的输入参数集，这取决于路由中多个可变点的值。例如：

myapi.com/<string:gameConsoleId>/games/<string:gameId>

Json参数（用于POST等）：

---

一个好的方法是查看一个流行且文档丰富的项目的现有文档，例如Python本身。Python文档使用多种方法来记录参数，这些参数可以采用一组值之一：

文本形式如：

模式参数应为“r”以读取现有文件，“w”以截断并写入新文件，或为“a”以附加到现有文件

项目符号值列表，可能带有说明，如：

模式可采用以下值之一（如stat模块中所定义）或它们的按位或组合：

• 统计数据
• 统计S_ISGID
• 统计S_ENFMT

如中所示的值及其说明表

---

如果你问的是关于文档和设计的问题，那么这可能是一个更好的问题。如果这主要是关于sphinx的，那么这将更多地是一个实现问题，在这里讨论这个主题。如果它主要是关于文档和设计的，那么它可能会像@Celeo所说的那样适合Progs。

我找不到一种内置的方法来描述有效的参数值

——对我来说，这似乎是普通的验证。或者你是在问一些其他的问题，比如REST URL，它根据其有效值进行自我记录？我要补充的是，这个备忘单是一个非常有用的补充：

:query gameConsoleId: The type of game console

:<json string gameConsoleId: The type of game console

[PLAYSTATION,XBOX,NINTENDO]