问题标签 [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 回答
63 浏览

php - PHP Swagger - 区域级别的路径

如何在区域级别指定路径?

目前我有这个:

我不希望公共 api 文档出现刷新令牌路径。试图在区域下移动路径,但没有成功。

我尝试在区域下移动路径但出现错误。

0 投票
1 回答
880 浏览

openapi - NelmioApiDocBundle v4.0.0-BETA1,未找到 $ref

我有这样的 DTO:

我试图在我的控制器中引用这个 DTO,但似乎这个文件没有被解析。

这导致:

用户注意:$ref "#/components/schemas/ProductDto" 在 /srv/vendor/doctrine/annotations/lib/Doctrine 中的 \Doctrine\Common\Annotations\DocParser->Annotation() 中找不到 @OA\Schema() /Common/Annotations/DocParser.php 在第 827 行

似乎如果我将我的 DTO 放入 Controller 命名空间,正在找到并解析该文件,但引用仍然不起作用。不过,它适用于纯 swagger-php 包。

我正在使用当前的 Beta(v4.0.0,NelmioApiDocBundle),因为我想使用 OpenAPI 3。我需要以不同的方式引用它吗?这是包中的错误,还是我做错了?

0 投票
3 回答
436 浏览

php - Symfony 4 - 在 LexikJWTAuthenticationBundle 中找不到 JWT

下午好,

我尝试在我的项目中使用 LexikJWTAuthenticationBundle,但我遇到了未生成的令牌的问题。我已经在 var/jwt 目录中设置了私钥和公钥。

当我尝试使用登录路由时,API 会返回此响应:

阿帕奇虚拟主机:

公共目录中的 .htaccess 文件:

security.yaml 安全性:

我希望成功使用登录路由并在其他路由上生成有效令牌。

0 投票
1 回答
211 浏览

php - 可以使用正则表达式进行 PSR-7 验证吗?(参数冲突)

我目前正在通过 Symfony (5.1) Routes 和 NelmioApiDocBundle 生成 OpenAPI 注释,

其中一条路线如下所示:

和另一个喜欢

我正在使用 League 的 OpenAPI PSR-7 消息验证器(https://github.com/thephpleague/openapi-psr7-validator),通过将 Symfony 请求转换为 PSR-7 请求symfony/psr-http-message-bridgenyholm/psr7。除了这两个端点外,一切都运行良好。我不断得到

The given request matched these operations: [/api/users/{id},get],[/api/charter-calculations/followed,get]. However, it matched not a single schema of theirs.

是否有可能/followed只能匹配/{id}?因此验证者会感到困惑?或者是{id}我已经完成的正则表达式?

0 投票
1 回答
4176 浏览

symfony - 如何在 Swagger (OpenApi) 中添加 JSON 请求和响应示例?

我的 Symfony 4 应用程序中有一个 API 端点,我想用 NelmioApiDocBundle 和 Swagger 记录它。端点将 JSON 作为请求数据并返回一些自定义 JSON 作为响应。如何使用注释将它们的示例添加到文档中?我在文档页面上看不到任何示例,只有描述。

0 投票
1 回答
316 浏览

nelmioapidocbundle - 如何使用 NelmioApiDocBundle(4.x) 为 /api/login_check 和 /api/token/refresh 生成 API 文档

我找到了一种使用 NelmioApiDocBundle(4.x) 为 /api/login_check 和 /api/token/refresh 生成 API 文档的方法。

我的项目是一个带有 Symfony 5.1 的 API REST。

有我的route.yaml

和我的config/packages/nelmio_api_doc.yaml

以及 /api/doc 的截图: /api/doc 的截图

我希望可以帮助某人:)

0 投票
1 回答
931 浏览

symfony - 找不到 Nelmio 4 安全定义索引

我尝试将 nelmio/api-doc-bundle 配置为将 Authorization 标头用于我的 Bearer 令牌。

nelmio_api_doc.yaml像这样配置它

但是当我到达 ui doc 页面时,我得到了:

注意:未定义索引:securityDefinitions

有人知道如何解决吗?

0 投票
1 回答
367 浏览

symfony - 在 NelmioApiDocBundle 中向 Swagger 添加身份验证文档

我将 Symfony (5) 与 NelmioApiDocBundle (4.0) 和 LexikJWTAuthenticationBundle 一起使用来使用 Swagger 创建 API。我已经设置了端点和身份验证,一切都按预期工作。我有功能齐全的身份验证 API,有一个文档,我可以成功生成 Open API 规范。规范中缺少一件事:“身份验证端点”,我找不到将其添加到生成的规范和文档的方法(覆盖整个身份验证除外)

因为我使用的是 Symfony 安全层和防火墙,并且它与 LexikJWTAuthenticationBundle 集成,所以没有地方设置 Swagger 注释,而且似乎 bundle 本身不能处理生成“安全部分” 前一段时间我使用 ApiPlatform 和那里是由“装饰者”完成的

任何人都知道有没有办法(注释?)来生成文档的安全部分,或者我必须从头开始创建身份验证保护(?)

0 投票
1 回答
136 浏览

symfony - NelmioApiDocBundle 将响应内容类型设置为文件

我正在使用 NelmioApiDocBundle 4.0 来生成我的 API 文档。当我尝试将响应类型设置为文件时,问题就开始了。我有一个从数据库中获取文件并将其作为 StreamedResponse 返回的方法:

此代码运行良好并返回请求的文件,但我无法在文档中设置适当的响应类型。我试过这种方式,所以 mi 注释看起来像这样:

但回应是:

当我设置内容属性时,问题就开始了,但没有它, 这就是结果

0 投票
2 回答
1973 浏览

symfony - 如何在 Symfony 4 上安装 Swagger?

我开始这样安装:
https
://symfony.com/doc/4.x/bundles/NelmioApiDocBundle/index.html 第1步。

第2步。


但是我没有 AppKernel 扩展内核。我**只有内核**和
`$contents = require $this->getProjectDir().'/config/bundles.php';`
所以我添加到**/config/bundles.php**

步骤 3.
我添加到config/routes.yaml

第 4 步。
我创建了config /packages/nelmio_api_doc.yaml

之后,我应该在 mysite/api/doc 上看到 Swagger 的页面
但我在 github 上只看到带有链接“NelmioApiDocBundle”的白页
我做错了什么?