问题标签 [swagger-php]

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 回答
5903 浏览

symfony - Symfony、nelmio/api-doc-bundle 和 @SWG\SecurityScheme

我正在尝试使用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 以识别具有全局定义的文件吗?

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

它真的有效吗?

0 投票
1 回答
1648 浏览

swagger-php - 缺少 Swagger-PHP 属性路径

在我使用 swagger-php 的项目中,在生产服务器上我收到验证错误“对象缺少必需的属性 ([\"paths\"])”。尽管这个错误招摇 UI 工作正常。

我的 php 文件中的注释:

招摇 api 响应是:

但大摇大摆的 UI doc 返回错误:

如何修复此错误?

0 投票
2 回答
7017 浏览

laravel - Swagger.php:如何更改 POST 请求标头内容类型

我使用 lib: darkaonline/l5-swagger (^5.5)(其中包含 swagger-php + swagger-ui),我需要在我的 POST 请求中更改标头 Content-Type 以上传文件(在 Laravel Input::file 中读取它('照片') )。我读到我应该向我的招摇中添加consumesproduces参数 - 这就是我所拥有的:

但是在请求中Content-typeAccept我总是得到application/json并且 laravel 无法读取上传的文件(当我使用 swagger-ui 生成请求时)。我应该如何更改上面的招摇以允许 laravel 读取 Input::file('photo') 表单由 swagger-ui 生成的 POST 请求?

0 投票
2 回答
4626 浏览

laravel - 招摇 CSV 帖子

我们正在为我们的 Laravel REST API 实现编写 Swagger 文档。一些 POST 端点将使用 CSV 作为参数内容类型。

Swagger 中有没有办法让“立即尝试”功能与 CSV POST 文件上传一起使用?

以下是我们正在进行的文档 http://api.curvecompass.com/docs/#/

我们让 Laravel POST 函数在 CSV 端点上正常工作,而不是 Swagger 文档。

0 投票
1 回答
1613 浏览

annotations - 带有链接属性数组的 Swagger 注释

我是 PHP Swagger 的新手,我使用 Laravel 包L5-Swagger为我的 API 创建文档。现在我试图让一个模型包含另一个模型的数组,一个订单可以有多个订单项。

不幸的是,我无法使链接正常工作。请参阅随附的屏幕截图。

在此处输入图像描述

我究竟做错了什么?

这是我的订单模型:

这是我的 OrderItem 模型:

0 投票
1 回答
349 浏览

swagger - 生成 .json 时出现 SWAGGER-PHP 错误我无法从我的模型中加载值

大家好,我试图消除在生成 swagger.json 时仍然存在的这个错误,错误说:

[警告] [语法错误] 预期值,在 \App\Http\Controllers 中得到“@”...在我的代码中,OHH iM WORKING WITH LUMEN。

当我检查 json 不生成定义 - >“定义”:{}。我的模型以下列方式定义它,我不知道问题是否在于我的模型位于不同的命名空间下,因为它被定义为供应商或我缺少的声明性内容:

..在我看来,swagger m 出现了一个错误...我认为这是因为它没有加载模型的值,这要感谢谁能帮助我

0 投票
1 回答
473 浏览

laravel-5.3 - 在 Laravel 中找不到类“Swagger\Swagger”的问题

我对 Swagger 很陌生,我刚刚安装了 slampenny/Swaggervel,当我打开以下网址时,它会抛出错误

错误:

网址:

0 投票
1 回答
661 浏览

swagger - 无法让数组键与 Swagger 一起使用

我想要做的是接收带有 key 的数字数组entries

此 docblock 呈现以下 CURL。

我怎样才能让它用密钥发送数组entries

0 投票
0 回答
203 浏览

laravel - 需要正确生成swagger json

问题是我需要文档来证明可以以数组的形式传输字段列,并在其中传输以下字段(名称、描述、created_at、updated_at、作者)。json 已成功生成,但在 swagger-editor 文档中,这些字段不可见

0 投票
1 回答
1377 浏览

laravel-5.2 - l5-Swagger 数据类型未定义

我正在使用laravel 5.2.*并且正在使用darkaonline/l5-swagger : ~3.0API 的文档。我在标头正文中发送参数,当我看到 Swagger UI 时,它显示如下。

数据类型未定义

有关更多详细信息,请参见下图。

招摇用户界面