Question

我使用Restler框架编写我的API，它使用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 = '') {

Answer 1

更新：如果您在RC6中使用Explorer类，并且可选参数仍然显示为必需，请下载最新更新。我们刚刚发布了一个修复程序！

您的示例是正确的，我们通过在PHP中指定默认值来标记可选参数。这足以将它们记录为可选的。如果您想要更清晰，可以在这些参数的描述中添加std::function<>

在Swagger文档中将restler方法参数标记为可选

1 个答案: