问题标签 [nelmioapidocbundle]

在使用 FOSRestBundle 工作了一段时间后，我觉得我错过了一些东西。在我看来，FOSRestBundle 和 Symfony 的 FormType - 有点相似。两者都是您的“数据经纪人”。每个人都有自己的东西，但最终它们是相似的。

如今，每个人都迁移到单页应用程序。这意味着每个人都在尝试使用他们现有的 FormType(s) 并使用 FOSRestBundle 构建 API。但是他们不能轻易地记录下来。NelmioApiDocBundle 不适用于 FormType。还是我错过了什么？

所以我的问题是：是否可以“告诉” NelmioApiDocBundle 使用 FormType 作为它的文档（描述所需的数据）？

似乎有解决此问题的方法，但它不起作用。

控制器注解：

表格类型：

服务.yml：

请指教，谢谢！

我使用以下版本：

我的控制器只有一个动作

这是我想在我的 Controller-Action 中使用的模型/定义：

但是当我转到 /api/doc 的文档页面时，我看到了这个错误：

我认识到的下一件事：我的product.php似乎根本没有被阅读swagger。我可以在这里写任何我想写的东西。没有错误，即使我拼错了什么。这使我得出结论，根本没有找到我的product.phpswagger。

我对每一个提示都有帮助。

亲切的问候，麦克斯

我想从 SwaggerUI 中排除“默认”部分 - 在那里我保留了我不想公开的路线。我知道在 Nelmio Apdoc 的 2.x 版本中，config.yml 中有一个名为 exclude_sections 的参数 - 我如何使用 3.0 beta 版本来做到这一点？

我开始了一个新的 Symfony 2.8 项目，我想用 swagger 来记录它。我安装了NelmioApiDocBundle并且工作正常。这是我唯一的路线：

我的路由.yml：

当我访问路线/api/doc时，它工作正常：

但是大摇大摆的一个：（/api/swagger应该根据：This doc工作）对于我的路线是空的：

命令 app/consoleapi:swagger:dump工作正常：

我错过了什么吗？

我想在某处写一个@SWG\Definition 并在@SWG\Response 注释中的@SWG\Schema 中引用它，以便在我的Symfony 3 应用程序中进行多个REST API 操作。我正在使用 Nelmio 的 api-doc-bundle 的 dev-master 版本，但我似乎可以找到任何暗示该定义应该去哪里的东西。Swagger-PHP 文档敦促尽可能不要重复，我想遵循该建议。有什么提示吗？

NelmioApiDocBundle 只允许单个配置文件为 .yml 。

但我有超过 200 个 URL 可供使用，并且全部用于不同的 Bundle。它可以正常工作，但很难在同一个文件中处理所有内容。

因此，如果有人有解决方案将“路径”划分为不同的单独文件。

我正在使用 symfony 2.7，我创建了 API，当我使用邮递员提交表单（json 数据）时，它不接受日期时间值。

表单生成器

命令

实体

请求 Json

错误

如何使用 Request 指定 dateTime 值？

我正在尝试使用nelmio/api-doc-bundle记录我的 Symfony 3.4 应用程序 API，但未能创建安全方案。

使用以下配置生成文档本身可以按预期工作：

以及以下注释：

所以我得到了一个像这样的正确的 JSON 文件：

现在的问题是我需要在ApiKeyAuth任何地方定义。根据我发现的例子......

https://github.com/zircote/swagger-php/blob/master/Examples/petstore.swagger.io/controllers/StoreController.php

https://github.com/zircote/swagger-php/blob/master/Examples/petstore.swagger.io/security.php

https://swagger.io/docs/specification/2-0/authentication/api-keys/

...可能如下所示：

但无论我将它放在控制器中的哪个位置，它都无法识别。

那么合适的地方在哪里呢？

我可以配置 api-doc-bundle 以识别具有全局定义的文件吗？

我需要在配置中创建定义而不是作为注释吗？

它真的有效吗？

NelmioApiDoc v2 允许使用多个views参数，因此我可以隐藏一些端点并将它们呈现在不同的 URL 上

https://symfony.com/doc/current/bundles/NelmioApiDocBundle/multiple-api-doc.html

是否可以在使用 Swagger 的 NelmioApiDoc v3 中做到这一点？

我正在使用 Symfony 3.3

这是 Symfony 3.4 项目中 composer.json 文件的 require 部分