问题标签 [nelmioapidocbundle]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
466 浏览

symfony - 转储文档 [NelmioApiDocBundle] v3.0

我在我的 symfony 4 项目中使用 NelmioApiDocBundle (v3.0),我想转储我的 Api 项目的文档。

我看到可以使用以下命令处理旧版本的 NelmioApiDocBundle:

但我收到了这个错误:“api:swagger”命名空间中没有定义命令

我不知道是否仍然可以使用新版本的 NelmioApiDocBundle 转储文档

0 投票
1 回答
1787 浏览

php - 未加载资产

我有问题,我的资产未加载 - 404 Not Found

"nelmio/api-doc-bundle": "^3.6@dev"

我执行php bin/console assets:installphp bin/console assets:install --symlink

本地工作,但在测试服务器上不工作......有人可以知道一些魔法吗?

本地请求 URL: http://symfony.localhost/bundles/nelmioapidoc/swagger-ui/swagger-ui-bundle.js - 加载正确

在测试服务器上 http://11.11.11.11/bundles/nelmioapidoc/swagger-ui/swagger-ui.css未加载

并返回错误

我检查了 中的文件/var/www/symfony/public/bundles,看起来正确,文件存在于nelmioapidoc. 我错过了什么?

fos 休息配置:

但我想这与 fos rest 无关。因为这是资产资源,所以应该不经处理就加载它。最重要的是,本地炒锅没有任何问题

另一件事,也许是服务器的问题。我将 Docker 与 nginx 映像一起使用。这是我的conf nginx.conf:

和主机

执行时测试服务器中文件的statat(我添加chmod 777 -R vendor/nelmio)assts:install --symlink(与propel值相同的情况,没有--symlink

比较本地的示例(工作正确的地方)

0 投票
0 回答
160 浏览

php - 在属性注释中使用模型的问题。应该是模型而不是数组

"nelmio/api-doc-bundle": "^3.6@dev" 我需要带有属性产品的模型响应,该模型Product和属性计数相等,但是当我使用 Mode 注释时,我遇到了问题,响应模型生成为 array Product。我做错了什么?

我期望的结果是这样的:

0 投票
1 回答
124 浏览

symfony - Symfony swagger 为内容类型添加注释

我想*/*在我的控制器注释中添加 Content-Type,我试过:

* @SWG\Get(produces={"*/*","application/json"})

这不起作用:

* @SWG\Get(produces={"*\//*","application/json"})

提前致谢

0 投票
1 回答
222 浏览

php - 有没有办法在 Swagger 中为我的方法(或排除方法)添加上下文?

我有 REST API,有些方法是公共的,有些方法是私有的。我想生成两个 API 文档,一个供所有人使用,另一个供私人使用。我使用https://github.com/nelmio/NelmioApiDocBundle,它使用https://github.com/zircote/swagger-php,它使用 Swagger 2。

结果的一个很好的例子是 JMS 的上下文,我们可以在其中将不同的组添加到我们的属性中,并在需要将它们私有时隐藏它们。

我知道在 Nelmio API 文档中,我们可以像在 JMS 中一样添加组,但我们不能以此隐藏方法。

在这些抽象的任何级别上是否有任何方法可以做到这一点?

0 投票
0 回答
745 浏览

symfony - Nelmioapidocbundle 不适用于 symfony 5.0.2 ans 注释

我尝试使用 nelmioapidocbundle :

当我使用这样的配置描述时,t 有效

但是当我使用注释时(安装了,我可以毫无问题地使用@Route,我得到这个错误:

任何想法 ?

0 投票
1 回答
145 浏览

php - 如何在注释参数中定义字符串数组

我正在使用 NelmioApiDoc 包编写 API 文档。一切都很好,除了一件事:使用注释在模式中标记必填字段。我有以下注释:

我想根据需要标记“thisIsRequired”。使用required=trueon 属性不是正确的方法,因为它应该放在 Schema 级别。

如果我使用 yaml 一切都很好:

并且必填字段用红色星号正确标记。我正在努力使用 PHPDoc:/ 我尝试过:

0 投票
0 回答
1826 浏览

symfony - 用户注意事项:未找到必需的@OA\PathItem():symfony 4

在此处输入图像描述我正在使用 symfony 4.4 / nelmio api doc bundle 4.0 / zircote swagger-php 3.0。当我尝试第一个示例时,出现此错误:用户注意:未找到必需的@OA\PathItem()

https://github.com/zircote/swagger-php/blob/3.0.0/Examples/example-object/example-object.php https://github.com/zircote/swagger-php/blob/3.0.0 /Examples/using-refs/ProductController.php

0 投票
1 回答
1532 浏览

swagger-php - 是否需要 nelmio_api_doc.yaml 中的架构部分?

我一直在使用 Swagger-PHP 设置 Nelmio API Doc Bundle。一切都按预期工作,我似乎无法弄清楚/理解的唯一一件事是模式。

在用户控制器中,我有以下注释:

在我的Entity/User课堂上,我将架构定义如下:

在用户控制器中,我也use App\Entity\User;定义了。

在我看来,这足以找到架构,但它不起作用,否则我不会在这里发布:)

我能够使其工作的唯一方法是运行vendor/bin/openapi --format yaml src模式输出并将其复制/粘贴到nelmio_api_doc.yaml文件中。这是我复制/粘贴的架构部分:

所以我的问题是,这是解决它的方法还是应该自动创建架构部分?

感谢您的任何见解。

0 投票
1 回答
1689 浏览

symfony4 - 包含对象的对象的 Swagger 注释问题

我正在为 Symfony 4 项目中的 rest api 编写端到端测试。

我使用 php 7.4、Swagger 注释、nelmio/api-doc-bundle 3.6.1、nelmio/cors-bundle 1.5.6

这是我的方法的控制器代码。

ProfessionDto 是定义交换数据的对象。它包含更多对象作为属性,因为我希望在返回的数据中有一些结构,而不仅仅是一堆键值对。

在 ProfessionDto 类中,我定义了与其他对象相关的属性,例如:

如果我用邮递员或通过我的测试调用 api 并将我的数据作为 json 传递,例如

我收到错误消息: TypeError: Typed property App\Api\Dto\ProfessionDto::$professionArea must be an instance of App\Api\Dto\ProfessionAreaDto or null, array used

我做错了什么?我期望太多了吗?对象中的对象是不可能的吗?