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

json - 如何在 swagger ui 中映射这个数组 json?

我正在用 php 处理 swagger ui,我正在尝试像下面那样映射 json

我从 swagger ui demos 中尝试过,但无法像上面的 json 那样得到映射,我怎样才能得到这个 json 映射,它的注释是什么?请帮忙

我的招摇班是

我的post api注释是:

通过这个我得到模型模式,如:

在此处输入图像描述

在此处输入图像描述

但我想要 json 模式,如:

请帮我..

0 投票
1 回答
1695 浏览

php - 在 Swagger UI 中更改 Curl URL

我正在使用 Slim Framework (v3) 开发一个新的 API。我正在尝试将此 API 与 Swagger UI 集成,但是当我单击“试用”按钮时,Swagger 会生成以下链接。

示例链接:

如果我不使用 Slim 是正确的,但 Slim API 的链接如下:

我想要的是 Swagger 使用 Slim API 的链接,我该怎么做才能做到这一点?我找不到“翻译”链接格式的方法。

我正在使用 Swagger-php 进行评论(注释)。

我希望你能帮助我。谢谢。

0 投票
1 回答
833 浏览

php - 将 Swagger operationId 与 swagger-php 中的控制器方法链接起来

嗨,我正在使用 swagger-php 规范创建一个虚拟 api。我已经从 github 下载了 swagger-php 包。我还使用 php Annotations 创建了一个有效的 json 文件。现在我坚持将 swagger json 操作与控制器方法联系起来。

我的控制器文件是:

0 投票
0 回答
551 浏览

php - 如何在 Swagger/PHP 中使参数在某些情况下是可选的,但在其他情况下是必需的?

我正在用 Swagger 记录 PHP REST-API。所以我定义了我的数据模型。我目前的问题是,某些字段的所需状态因不同的请求类型而异。我的模型如下所示:

  • 在发布请求中,firstName 和 lastName 是必需的,并且 id 和 created 由 api 分配。
  • 在 put 请求 id 是必需的,但在 url 路径和 firstName 和 lastName 是可选的,而创建时不能更改。
  • 在获取请求时,所有字段都将返回。

想要的是:

  • 显示获取请求的所有字段。
  • 根据需要显示 id,并在 put 请求上显示名字和姓氏作为可选,但不显示已创建。
  • 根据发布请求的要求显示名字和姓氏,但不显示 id 和 created。

我知道我可以使用 required=true 将字段标记为必填字段,但这会将它们标记为在使用模型的任何地方都是必需的。到目前为止,我唯一想到的是 put 请求中所需的 id,因为它本身就是一个参数。

0 投票
1 回答
549 浏览

php - Swagger php - 在不拆分代码的情况下过滤公共/私有 API

我正在考虑使用 Zircote Swagger PHP 来记录 API。我还不完全熟悉它,因为在承诺使用它之前我一直在尝试回答这个问题。

我想要两组不同的文档。一个文档页面将包含我们所有的 API,而另一个将仅包含那些应该公开记录的 API。

我找到了这个答案,它或多或少地给了我正在寻找的结果。但是,他们建议的解决方案要求我对现有代码进行重大重构,因为我们的公共和私有 API 的实现尚未按照答案建议的方式进行拆分。

有没有办法在注释中标记单个 API,并在我生成文档时过滤这些标签?

0 投票
2 回答
704 浏览

swagger - 无法安装 Swagger Php

我正在尝试从http://blog.nbostech.com/2016/01/integrating-swagger-ui-for-php-application/为 ubuntu 安装 Swagger php

在那个链接中,他们要求我运行以下命令 - “php composer.phar 需要 zircote/swagger-php”。

当我给出时,“php composer.phar 需要 zircote/swagger-php”在我的终端中显示“无法打开输入文件:composer.phar”。由于这个错误,我无法从上面的链接进行 swagger-php 安装。

我需要支持。

0 投票
1 回答
1214 浏览

swagger-php - Swagger PHP 安全架构引用不佳

我正在使用这个 SecuritySchema 来定义 JWT 安全验证:

并将其引用为:

并且规范说我应该参考

但事实是 Swagger-PHP 生成:

在 Swagger UI 上显示为验证错误。

问题是: 如何模拟所需的输出以避免 Swagger UI 和 Swagger PHP 警告/错误?

0 投票
0 回答
292 浏览

php - 如何在 PHP-Swagger 上提供 JSON 数据样本

目前我正在使用 Laravel 创建 API 和库DarkaOnline -基于PHP-Swagger创建 API 文档的 L5 Swagger。

我的问题是如何大摇大摆地提供 JSON 数据样本?

目前我可以在参数描述上做这样的事情: 参数说明上的 JSON 数据样本 但是看起来很丑而且不长,让读者很困惑。有没有最好的方法来做到这一点?

0 投票
1 回答
2191 浏览

php - 如何在 swagger zircote 学说中正确添加参数而不会出错

我第一次使用 swagger,下面的代码导致“不是有效的参数定义”错误。


我发现我需要为我的所有参数创建一个定义(但是如何?):

我可以在zircote中使用:

除了我的参数不是属性,它只是静态方法中的一个 POST 参数

如何正确执行此操作?

添加:

我所有端点的完整json是:

这是错误:

0 投票
1 回答
184 浏览

php - Swagger php 不同版本的一个定义

我正在使用注释 swagger-php 为我的 API 设置 Swagger。我无法理解的是如何定义资源的不同定义。

我有一个User有 ID、电子邮件、密码和电话的课程。

以下操作接收各自的参数

create: email, password,phone

update: email, password, phone,oldPassword

get操作将返回id, email, phone+ 一些通过不同端点创建和更新的相关模型。

因此,这些中的每一个都使用它自己的定义,User我不确定如何巧妙地定义它,而不仅仅是跨不同定义(DRY)复制属性。

我想过创建一个

BaseUseremail, phone,

那么NewUser那将添加password

然后UpdateUser添加oldPassword

并将与只读关系属性FullUser结合起来。BaseUser

但是该死的,对于这样一个微不足道的事情来说它是如此复杂,所有这些参考地狱然后都会反映在 swagger.json 中。

有解决此类问题的方法吗?