问题标签 [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 投票
0 回答
648 浏览

symfony - Symfony 4 NelmioApiDocBundle 安全标头未设置

我正在使用 Symfony 4 和NelmioApiDocBundle作为 API。

我有捆绑包设置和工作,但我试图apiKey在默认情况下在所有端点中要求一个标头。

我已经按照文档进行操作,但我看不到TEST-KEY我运行时try it out的标题/api/docs- 我做错了什么?

nelmio_api_doc.yml

应用\控制器\TestController.php

我也尝试过这种方法,但也没有运气:

0 投票
0 回答
1018 浏览

symfony - 如何在 Nelmio API DOC vs 3 中定义关联数组?

我正在使用带有 Nelmio API DOC 与 3 的 Symfomy 3.4。

我有一个 GET API,其乘数参数的格式为:multiplier[14]=2&multiplier[15]=1。我希望能够使用数组的键从 /api-doc 面板发出请求,而不仅仅是值。此时,我只能添加值。

我此时定义关系的方式是:

我尝试了几件事,比如

但它似乎不起作用。

如何使密钥出现在面板中以便我可以在那里完成它,而不使用外部的东西,例如邮递员?

0 投票
1 回答
2860 浏览

api - Symfony 4.2 和 Nelmio Api Doc Bundle - 带有多个控制器的几个文档

我正在使用 Symfony 4 和 Nelmio Api Doc Bundle 创建一个只能通过 API 访问的服务(公共前端和私人后台都将使用 JS 框架创建)

我需要 2 份文件(以后可能会更多):

  • /api/doc
  • /管理员/文档

现在我在 src/Controllers/Admin 和 src/Controller/API 中有一些控制器,因为它们确实不同。

我不明白如何使用 Nelmio Api Doc Bundle 来处理 2 个不同 url 中的 2 个文档。我知道有一些区域,但我只是不知道如何处理它们......

有人可以通过提供一个简单的例子来帮助我吗?

谢谢

0 投票
1 回答
574 浏览

swagger - “nelmio_api_doc”下无法识别的选项“sandbox, swagger”。可用选项是“区域”、“文档”、“模型”

我正在尝试为我使用 Symfony 4 开发的应用程序实现一个 Rest API。在安装了诸如nelmio/api-doc-bundle 之类的包之后(我的 composer.json 粘贴在下面),我收到以下错误:

InvalidConfigurationException “nelmio_api_doc”下无法识别的选项“sandbox, swagger”。可用选项是“区域”、“文档”、“模型”。.

我试图弄清楚这几天发生了什么。请需要帮助。

这是我的 composer.json :

这是我的 nelmio_api_doc.yaml

我试过:作曲家更新和作曲家安装。

0 投票
1 回答
667 浏览

php - 如何使用自定义 JMS 序列化程序处理程序设置 Nelmio Doc

在生成的 NelmioApiBundle 中,我的关系显示为 {} 而不是 0。

我对对象关系使用自定义 JMS 处理程序。(关系处理程序)

在我的关系中,我在给定的模型(ChildRelation)中指定了一个特殊的类作为类型。然后,处理程序管理从 Object 到 ID 的转换。这适用于 JMS Serializer 但不适用于相应的 Nelmio API Doc

我试图直接在 ChildRelation 上弄乱@SWG\Schema 但这没有用

在这个示例中,角色在技术上是一个继承自 Concrete 的 UserRole 对象。

我希望得到与调用端点时相同的模型。

但大摇大摆的反应是这样的:

有没有很好的方法来做到这一点?

0 投票
2 回答
3326 浏览

annotations - 数组对象的 Swagger PHP 注释

我想在 api/doc 视图中包含对象数组。但我无法得到那个。

从下面的代码:

我得到输出:

但我想要以下一个:

请帮我解决这个问题。

0 投票
1 回答
4598 浏览

php - 查询参数的 Swagger 注释

我正在将 POST 请求转换为 GET 请求。我正在使用 NelmioApiDocBundle 来记录我的 API 端点。我目前有以下(旧)注释:

现在我希望开发人员能够使用https://myapi.myapp.com/open-vacancies?page=1&pageSize=10. 但我不知道如何以注释形式定义文档。谷歌对我帮助不大。有人可以指出我的相关文档(或者,如果失败,请输入我可以使用的注释示例)?

0 投票
1 回答
144 浏览

symfony - NelmioApiDocBundle:使用选项模型时:use_jms:false 此结果导致此错误:

我已经尝试清除 symfony 和我的虚拟机的缓存,但仍然没有运气。

我希望有人熟悉这里的问题并指出我正确的方向。谢谢。

0 投票
1 回答
208 浏览

php - NelmioApiDocBundle 的渲染问题

我对“NelmioApiDocBundle”包有疑问。

我的渲染 https://localhost:8000/api/doc

当它应该是更多的设计时,渲染是原始的。

我的包裹

你有过这样的问题吗?

谢谢

0 投票
2 回答
3069 浏览

symfony - Nelmio API doc area and bearer token with symfony 4

I have API in Symfony 4. I added NelmioApiDocBundle to my project, but i have problem with my docs. This is my configuration: packages\nelmio_api_doc.yaml

config\routes.yaml

This i my swagger ui screen: enter image description here

I have controller: SpeakerController, HomeController, How can I make each controller a separate area and the rest in default? i.e. SpeakerController in area Speaker, HomeController in area Home etc ..

My next problem is that I have an API protected by a bearer token, when I click Authorize in the swagger, I will add the current jwt token and I want to request it, in response I get:

In postman i don't have problem: enter image description here