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

swagger - 同一方法的两条路径

一直在尝试使用 Swagger 为我的 PHP Rest API 生成文档,使用 swagger-php。

它工作得非常好,不太确定我是否喜欢由于文档而拥有大量评论块,但这不是问题。

我有两条路:

它们都在我的 PHP 代码中调用了相同的方法:login()。

我有没有办法说 /user/ [POST] 只是 /user/login [POST] 的别名?

我希望他们两个都出现在操作列表中,并附上他们的文档,并说他们做同样的事情,只是用不同的路径向用户提供选项。

我当然可以复制粘贴注释块,但我真的不希望一个 50 行的注释块用于只调用另一种方法的单行方法。

有任何想法吗 ?

0 投票
1 回答
835 浏览

php - swagger-php 具有来自相同代码的不同文档

我们正在使用 slim 框架和 swagger-php 来动态生成 swagger 文档。我们现在在 API 中有一些不应该公开记录的特殊方法。(/doc now) 有什么方法可以让我获得第二个文档 url (/doc2),我可以在其中记录秘密方法和参数?(无需手动制作文档,只需使用 php 代码中的注释即可)。谢谢。

0 投票
1 回答
3694 浏览

swagger - 如何在 Swagger 中为 GET 请求生成模型/示例值部分

我担心使用 Swagger 为我的 GET 请求生成模型/示例值部分。 官方示例的链接完美地显示了该部分。

在官方文档中,它是使用现有模型生成的:

我没有这样的选择,因为我的属性是由 REST 生成的。

我尝试了以下方法:

它不起作用并回答:

fetching resource list: http://localhost/dist/swagger.json; Please wait.

非常感谢任何帮助。提前致谢。

0 投票
1 回答
2075 浏览

swagger - 如何在 Swagger Annotations 中使用 PHP 变量

首先我对这个 Swagger PHP 感到非常兴奋,非常有表​​现力!

有什么方法可以在 swagger 注释中提供 PHP 变量。

下面是我的代码:

也尝试在注释中提供 $api_path 之类的内容,但将其作为字符串和 API 调用失败....

任何帮助将不胜感激

0 投票
1 回答
309 浏览

swagger - Swagger UI 排序不适用于 v2.1.4 版本

嗨,我已经使用 JSON 对象实现了 Swagger UI,但问题是“路径”(API 调用)没有按字母数字顺序显示,而是我在 JavaScript 中将“apisSorter”作为 alpha 给出。

当我使用调试工具时,JSON 输出在 Web 控制台中正确显示,但在网页中显示时,它的显示顺序是我在注释页面中提到的,而不是字母数字方式。

下面是代码:

即使我尝试从服务器端对 JSON 进行排序,但没有帮助。

下面是代码:

任何帮助表示赞赏。

0 投票
0 回答
788 浏览

php - 在 swagger 注释中使用常量

我有以下代码:在/lib/App/Vendor/bin我创建了一个文件:constants.php带有一个定义 define('AUTH', 'test');现在当我尝试执行时php swagger --boostrap constants.php

我得到错误:

Scanning files in '/lib/App/Vendor/bin' ...[INFO] Required @SWG\Info() not found 我不明白问题出在哪里。请帮我 !提前谢谢!请帮帮我......现在有人问题了吗?

0 投票
1 回答
161 浏览

php - PHPUnit 断言项目

我正在开发一个 PHP 项目,该项目需要验证对预定义模式的 JSON 请求,该模式可在 swagger 中使用。现在我已经完成了我的研究,发现最好的项目是 SwaggerAssertions:

https://github.com/Maks3w/SwaggerAssertions

在 SwaggerAssertions/tests/PhpUnit/AssertsTraitTest.php 中,我很想使用 testAssertRequestBodyMatch 方法,您可以在其中执行以下操作:

上面的这个断言正是我所需要的,但是如果我传递了一个无效的请求,它会导致一个致命的错误。我想捕获这个并处理响应而不是应用程序完全退出。

我如何利用这个项目,即使它看起来像是 PHPUnit 的全部?我不太确定如何在正常的 PHP 生产代码中使用这个项目。任何帮助将不胜感激。

0 投票
1 回答
11761 浏览

php - Swagger PHP - 如何定义嵌套属性?

我正在使用 Swagger PHP,并且大多数定义都很容易定义,但是我遇到了一个特定数据的问题,该数据不是单独类的一部分,而是关联数组的一部分。

我希望显示的 json 响应(针对这个问题进行了简化):

和很容易定义,但是id是一个问题,因为没有单独的类来定义它,它是模型内部的一个数组。是否可以在不必创建虚拟类的情况下定义此数组?statusgps

目前模型文件中的注释:

0 投票
7 回答
10398 浏览

php - 我可以让 swagger-php 在查询字符串上使用数组吗?

我使用 Swagger-php。当我在查询字符串上定义一个参数时,它可以是一个数组。但据我所知,它不支持这种查询字符串:

如果可能的话,我相信这将collectionFormat现场设置。目前我一直在使用pipes,但我想使用上述格式,并让 Swagger-UI 也反映这一点。但是,我阅读了这个 github 问题,这让我想知道这是否真的可行,而我只是错过了它?

我的 Swagger-PHP 定义示例:

这会产生以下 JSON:

0 投票
1 回答
5393 浏览

php - 如何在 swagger php api 注释中传递可选参数?

我正在使用 swagger ui,我有一个 Get api,它采用可选参数,但我无法为该 api 提供注释,下面是我尝试过的 make 代码:

我的 Get api 结构是这样的:

但是当我尝试这样做时,swagger ui 不采用id可选参数,它采用必需参数,帮助我..