在swagger文档中将restler方法参数标记为可选
我使用Restler框架来编写我的API，它使用swagger来记录东西。当我定义我的方法时，我对结果文档有两个问题。一个是参数的描述没有显示在swagger中，另一个是它说它们都是必需的。我如何在文档中将它们标记为可选的？我正在做类似下面的事情，其中类别和图片是可选参数。
/**
* Create a new News post
*
* Creates a new News post
*
* @param string $title The title of the task.
* @param string $url The URL of the webpage to display.
* @param string $body The text of the news article.
* @param int $team_id The sql_ident of the Team this news article relates to.
* @param string $categories The comma separated list of categories.
* @param string $picture The URL to the picture to display.
*
* @status 201
*
* @return array The sql_ident of the new article
*/
function post($title, $url, $body, $team_id, $categories = '', $picture = '') {
共有1个答案
更新：如果您在RC6中使用Explorer类并且可选参数仍按要求显示，请下载最新更新。我们刚刚为此发布了修复程序！
您的示例是正确的，我们通过在PHP中指定默认值来标记可选参数。这足以将它们记录为可选。如果您想要更清晰，您也可以在这些参数的描述中添加（可选）
-
是否可以以某种方式标记属性，以便在发送请求时可以理解在SwaggerUI中应设置哪个字段。 例如，我们有一个支付路由，它具有payment_type属性，可以保存paypal、credit_card、crypto等值。基于该字段，我们需要填充不同的属性，如下所示。 是否有可能以某种方式标记它们，以便将它们分组，例如对于加密加密货币，应该设置wallet_address，而对于银行转帐，应设置快速，
-
我正在使用 Swagger for WebApi 5.5.3 nuget 包作为 API 文档。在招摇的 UI 中，它显示可选参数的必需选项。 我在Visual studio中尝试了XML注释选项。以下是我要记录的 API 方法： 它将lastSyncDate显示为查询参数，但是当我将其标记为可为空的参数时，它是必需的。 我还尝试使当前PageIndex在xml和路由中为空，但仍然根据需要显示所有
-
我已经将swagger与django rest框架集成在一起，但是swagger文档没有创建一个输入框来发布post请求的数据。 我的解析器设置, }
-
我想在我的 rest 服务的自动生成的 swagger ui 文档中添加一个标头参数字段。我使用Spring和Spring狐。 如您所见，我已经有一个体型参数。我只想添加一个标题类型。
-
问题内容： 最近，我与队友讨论了 在方法中使用可选参数的问题。 假设方法是 接受一个和 可选参数 ，它返回该目录中列出的书籍，如果还传递了类别，则仅返回该类别中的书籍。 冲突点是，验证是否为空检查。我认为不应对此进行空检查，因为它是可选参数。函数的调用者可以通过或，并且函数应在实现中处理两种情况。 我的意见是，对于可选参数，只会使方法的约定更加明确。只需查看方法签名即可知道此参数是可选的，不需要读
-
最近，我和我的队友讨论了在方法中使用作为可选参数。 假设方法是 我的观点是，对于可选参数，只会使方法的契约更加清晰。只要看一下方法签名就可以知道这个参数是可选的，不需要读取JavaDocs。但当他不想使用该可选参数时，不应强制他传递。 我的队友有不同的看法。他希望对其进行空检查，从而强制调用方始终传递。他的观点是为什么我们要通过一个空的可选选项。此外，看起来比更易读。 这个方法在我们的一个库包中，