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

swagger - 如何在 Swagger-PHP 中指定默认的 JSON 正文?

我想在 Swagger-PHP 中为 POST 请求指定默认的 JSON 正文。我的注释如下所示:

如您所见,我正在尝试使用default="{}",但 Swagger UI 忽略此值并将“字符串”作为默认值来实现默认值:

在此处输入图像描述

如何将“字符串”部分更改为默认 JSON 对象?

0 投票
0 回答
438 浏览

swagger - NelmioApiDoc 模型定义/如何忽略具有其他名称的现有属性的 getter 或别名?

我们可以覆盖模型访问器属性名称或忽略它吗?

这是我的User::getUsername函数,它是电子邮件属性的吸气剂(我需要这样命名的函数来实现接口):

并且生成的文档仍然显示:

你能帮我吗?

0 投票
0 回答
494 浏览

swagger - Phalcon Zircote/Swagger-php 安全错误

我正在尝试Swagger-php在我正在处理的应用程序中创建 API 文档。我想使用 JWT 保护它,所以在我的 ControllerBase 中放置了一个 SecurityScheme:

然后在我的控制器中我想使用它

它在我的 Swagger UI 上正确加载,但是当我尝试执行请求时,我收到错误响应:

语法错误,意外标记 },靠近 '}}

看起来 Swagger 的正确注释对于 PHP 解释器是不正确的。我可以将其更改为

然后请求正在工作,但是当我重新加载 Swagger UI 时,请求不会出现在那里。

任何人都可以帮助我吗?

更新:我错误地认为这是 PHP 解释器的问题。使用 Phalcon Annotations 时出现问题。这是服务器返回的整个错误。

第 21 行 /var/www/api/api/app/modules/user/controllers/UserController.php 中的语法错误,意外标记 },靠近 '}} )'

p>

0 投票
3 回答
1918 浏览

php - swagger php将参数作为json传递

所以我在我的 php 代码中有如下评论,所以基本上我正在尝试生成我的 api 接受的以下类型的请求。

我有如下评论:

预期产出

实际输出

在 Swagger-ui 中,当我尝试执行它时,它给了我错误:

类型错误:获取失败

我试过的

  1. 更改消耗为“multipart/form-data”(同样的错误)
  2. 如果我将 in="body" 更改为 in="query" 那么它可以工作,但我不能使用它。因为它需要在 POST 方法中传递参数。
  3. 可能不相关,但在控制台中我收到以下错误:

root-injects.js:95 TypeError: e.get(...).entrySeq is not a function at t.default (curlify.js:23) at t.value (curl.jsx:17) at t.render ( root-injects.js:93) 在 u._renderValidatedComponentWithoutOwnerOrContext (ReactCompositeComponent.js:796) 在 u._renderValidatedComponent (ReactCompositeComponent.js:819) 在 u._updateRenderedComponent (ReactCompositeComponent.js:743) 在 u._performComponentUpdate (ReactCompositeComponent.js: 721) 在 updateComponent (ReactCompositeComponent.js:642) 在 u.receiveComponent (ReactCompositeComponent.js:544) 在 Object.receiveComponent (ReactReconciler.js:122)

那么我应该怎么做才能解决这个问题呢?

0 投票
0 回答
21 浏览

swagger - 生成SDK需要正确生成swagger json

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

0 投票
1 回答
631 浏览

laravel - 试图在招摇 UI 中创建一个包含多个项目的数组

我正在尝试为具有多个输入的 Swagger UI 创建一个数组,但我不知道如何。我目前看到的只是 Swagger UI 中的一个字段。

代码:

0 投票
1 回答
9792 浏览

php - 如何为 swagger-php OpenApi 添加接受应用程序/json 标头

我正在使用L5-Swagger 5.7.* 包(Swagger-php的包装器)并尝试描述 Laravel REST API。所以,我的代码是这样的:

但是当我尝试通过招摇面板发送请求时,我得到了代码:

如您所见,accept 不是 application/json 并且 Laravel 不会将其识别为 AJAX 请求。因此,当我发送错误数据并期望得到 422 实际错误时,我会在“会话”中得到 200 个错误代码。通过 swagger 面板的请求 (XHR) 也被错误地处理,CURL 代码只是为了清楚起见。

另外,我发现在以前的版本中使用了类似的东西:

但现在它已经过时了。

那么,如果验证失败,如何在不重定向的情况下获取 422 代码?或者可能添加“XMLHttpRequest”标头?在这里做的最好的事情是什么?

0 投票
1 回答
2509 浏览

php - 用于 PHP 数组的 Swagger

我正在尝试创建一个应返回如下数组的响应示例:

为此,我正在使用以下代码:

我在招摇中心得到这个:

0 投票
1 回答
962 浏览

php - Swagger-php 如何排除整个 /vendor 文件夹但附加一个带有共享模型的子文件夹

我正在使用的包是Swagger-php

我目前通过执行生成招摇文件:

./vendor/bin/openapi --output storage/app/swagger/swagger.json --exclude tests --exclude storage --exclude vendor ./

而且我有一些模型在多个 api 之间共享,所以我希望 swagger 模式定义与这些模型一起使用

./vendor/utilities/php-general-tools/src/models/

所以我需要包括那个文件夹,但它目前被排除在外.. 显示的错误是

0 投票
1 回答
1264 浏览

php - 在 Swagger 检查器中设置表单数据发布参数

我刚刚开始为记录的 api 招摇。我正在使用 Swagger 检查器来执行 api,在此之前我使用的是 Postman。我在 Swagger 正文中传递数据但没有获取数据,同样的事情在 Postman 中有效,但在此处无效。

此外,get request 可与 Swagger 一起使用,但 post 无法正常工作。

在 Postman 中获得响应:

在此处输入图像描述

同样的事情在 Swagger 中不起作用:

在此处输入图像描述

我已经设置了标题,但没有在帖子中获取我的参数。 在此处输入图像描述