问题标签 [nelmioapidocbundle]

现在我尝试使用 NelmioApiDocBundle 在 Symfony 3 中创建 API 文档。到目前为止，一切都按照给定的 symfony 文档中的描述工作。

现在我想从 swagger 文档中删除 _error 和 _profiler 路由。它说你可以只使用 path_patterns。所以我需要在文档中写下我需要的所有路线。但我有很多不同的路径。

有机会创造负面的路径模式会很酷，比如

这样的事情可能吗？

首先对我糟糕的英语感到抱歉。

我想为我的 api 使用 NelmioApiDoc，安装和配置我没有问题，我的路线返回这个结果： nemlio return

当我尝试向控制器插入注释时，没有任何变化，页面没有变化。我的控制器：

如果你对我有回应，我接受！谢谢大家

在理解标题中的工具组合时遇到了一些麻烦。

当我查看我的文档时，模型是空的：

也就是说，我尝试了很多方法，包括禁用 jms，但我想使用 JMS。

这是我的配置：

nelmio_api_doc.yaml：

用户模型：

用户控制器：

任何帮助或想法都会很棒，我尝试在 id 中添加一个组，但它仍然不起作用，我将它留在了代码示例中。我错过了什么？

我刚刚nelmio/api-doc-bundle使用作曲家从 3.2 更新到 4.3。现在，当我查看/api/doc.json我的应用程序（之前显示 API 端点列表）时，我收到此错误：

找不到“GET /api/doc.json”的路由

以下是 的内容config/routes/nelmio_api_doc.yaml：

为了使我的文档端点再次工作，我需要在我的应用程序中进行哪些更改？

我的模型如下所示：

控制器中的代码：

在这种情况下，NelmioApiDocBundle 将生成

因为注释ResponseBodyModel::$data是@var AbstractModel（我知道这一点）

如何为参数编写注释以ResponseBodyModel::$data根据集合组选择正确的类模型：

• 当我设置@group comment_create- 选择CommentModel::class
• 当我设置@gropu comment_list- 选择CollectionModel::class

在 NelmioApiBundle 的文档中与此无关 https://symfony.com/doc/4.x/bundles/NelmioApiDocBundle/index.html

我也找不到任何关于这个的东西https://swagger.io/specification/。

类似的问题已经出现，但 Symfony 和 NelmioApiDoc 的版本不同。而且我不确定是这种组合还是我在上面使用 FesRestBundle 的事实。

我的问题如下：运行单元测试时出现以下错误

[语义错误] 从未导入方法 App\RestController\DnsEndpointsController::getDnsEndpointsAction() 中的注释“@OpenAPI\Annotations\Tag”。您是否可能忘记为此注释添加“使用”语句？

这是我导致此错误的相关代码：

相关配置是这样的：

和：

请注意我对这些注释的三个问题：

1. 尽管我明确声明use OpenAPI\Annotations\Tag;它不被认可。这个注释甚至完全类似于 Zircote 这里的显式示例：Swagger-PHP v3.x。另请注意，前面@Rest\Route的内容已通过并正确解析。

2. 无论我是否使用缩写导入（如use OpenAPI\Annotations as OA;随后@OA\Tag）或示例中的显式类导入，结果都没有区别。

3. 有没有办法明确地验证注释而不是等待 phpunit 运行测试？在这个阶段，我正在等待数百分钟盯着管道进度，这更加增加了我对这个问题的挫败感。

对这个有任何想法吗？我错过了什么？

目前，我总是使用带有 Swagger 注释的 NelmioApiDocBundle 来编写我的 API 文档。我希望将这些注释移动到 yaml 文件中，但我没有找到有关如何执行此操作的任何信息。使用 NelmioApiDocBundle 或其他捆绑软件。

有任何想法吗 ？

我的注释是：

我试图添加一个“示例”键，但它不起作用。

我创建了一个用于测试目的的 symfony 应用程序并导入了 NelmioApiDoc 包。

我尝试实现与 Symfony 在其文档https://symfony.com/doc/current/bundles/NelmioApiDocBundle/index.html中演示的几乎相同的逻辑和结构。

但是，当我尝试在 http://localhost/api/docs 访问 Swagger UI 时，Symfony 报告错误：... a Describer doesn't exist for type Reward ...

问题在于：@SWG\Items(ref=@Model(type=Reward::class, groups={"full"}))。

该文档对初学者不太友好。你能告诉我我错过了什么吗？

我已经在实时服务器（生产）上部署了我的 Symfony 5 应用程序。我把我的.env文件留下了 DEV 变量。

首先我的主页index.php显示404 URL not found on the server，所以我必须执行ln -s public_src public，因为我的主页显示正常。

但是，我需要并通过 composer 实现了一个 NelmioApiDocBundle，现在我的 API 文档路由/api/doc仅在 localhost 上工作，在浏览器显示的实时服务器（生产）上404 URL not found on the server。

如何解决？它需要另一个符号链接吗？