问题标签 [nelmioapidocbundle]

我想在 Nelmio API Doc Bundle 的沙箱中的 Headers 中定义一个参数。

如何在 Nelmio ApiDoc 的注释中定义它？

我正在使用 Nelmio API 文档使用 FOSRestBundle 和 JMSSerializer 为我的 REST api 生成文档。生成的文档说我的 json 对象实际上是数组。如何让文档说我的对象是对象？

我知道，在 php 中，这些字段实际上是键值关联数组，但在实际的 json 中，它们是对象，我希望我的文档能够反映这一点。

这是我的代码实体：

控制器：

我正在使用（并且是新手）Symfony 3 和 NelmioApiDocbundle。我想处理具有可选查询参数的 POST 请求。网址将类似于： http ://example.com/api/updateusers?token=some_long_value

这是我为我的注释尝试过的：

要求、参数和过滤器都显示在 API 沙箱的 POST 正文中。我可以使用另一种定义类型来在 API 沙箱中显示查询参数吗？如果我绕过沙箱并将请求直接发送到服务器，则令牌会正确显示为 GET 值。但我希望能够使用 API 沙箱进行测试和记录。

我正在使用 symfony 2.6.1，我正在使用 FosRestApiBundle 并且我想记录它，所以我尝试了 NelmioApiDocBundle，问题是在发布请求中，我无法设置发布请求的正文，是否存在这个问题的任何解决方案？谢谢你。

请我需要你的帮助，我正在尝试使用 nelmio 包插入图像，但它给了我这个错误参数标签值''违反了约束（类型为 \"array 或 Traversable\"，\"string\" 的预期参数)"

我的控制器如下

请问如何解决

默认情况下，ApiDoc 列出每个 API 端点的所有操作，如下所示：

然而，在Swagger 演示中，操作默认隐藏，直到用户选择显示它们。

ApiDoc 是否有默认隐藏操作的配置选项？我在文档中没有找到类似的东西。

我将NelmioApiDocBundle与 PHP 框架Symfony3一起用于REST API。我想在 /api/doc 页面中显示我的参数的描述。如果不手动添加参数，这可能吗？我想从输入/输出类中导入它。

这是我的文档的外观：

这是生成文档的控制器操作（/api/user/login）的我的@ApiDoc ：

AppBundle\Libraries\Core\User\LoginRequest类：

我想使用这个类的描述，例如。用户名：“用户名。”，密码：“密码。” 而对于 rememberPassword：“定义是否将刷新令牌保存为 Cooke。”。

谢谢您的帮助。

问候奥兰多

我使用 Nelmio API Doc Bundle 来公开我的 api 文档。我将它与基本配置一起使用。也使用 Symfony 3.1。但是在控制器上，即使我在 ApiDoc 注释中定义输入参数，文档也不会显示输入。

我缺少任何配置吗？或任何已知的错误？

谢谢

有没有办法关闭所有 Nelmio Swagger UI 文档？在生产中，我希望外界在以下 URL 中看不到任何内容，但在开发中，它们应该正常显示有用的文档和沙箱：

• http://ourserver.com/api/doc
• http://ourserver.com/api-docs
• http://ourserver.com/api-docs/ *

似乎在 Nelmio 配置中应该有一个简单的开关，但我还没有找到它。我的公司正在使用 Symfony 中的 Nelmio API Doc 包为非公共 API 开发 API。API 服务器向公众公开，但我们对向全世界发布其使用情况不感兴趣。

我正在使用 FOSRestBundle，而且我在 Symfony 中还很新。

我一直在关注一些我见过的例子，但我不能在请求中添加多个参数。

例如

工作正常，但如果我想做这样的变化：

它不起作用。它仅标识 $id

有什么我不知道的限制吗？还是我所做的简单修改之外的一些额外配置？