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

php - 如何修复ErrorException:@OA\Property() 的类型为“array”时需要@OA\Items()?

我试图添加任意类型的嵌套数组。这些是我的注释:

0 投票
1 回答
440 浏览

api - Swagger 代码生成构建失败

我已经在 swagger github 存储库中问过这个问题,但是社区看起来反应不是很好,所以我要在这里尝试一下。

README之后,我正在运行此命令来生成 PHP 客户端(但它可以是任何其他语言):

我收到以下错误:

有人有同样的错误吗?我想弄清楚是不是只有我一个人。也许我错过了一些东西。

0 投票
1 回答
3308 浏览

php - 使用 swagger-php 将嵌套属性序列化为表单数据

这就是在 OpenApi https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md中完成编码对象示例的方式

我正在尝试使用 swagger-php 来实现相同的目标。我不知道的是如何传入encodings对属性@OA\MediaType进行编码,因为默认情况下被编码为testmultipart/form-dataapplication/json

前任:

他们在这里有一些例子:

https://github.com/zircote/swagger-php/tree/master/Examples

但我没有找到任何关于编码的例子

在这里,该字段定义为 https://github.com/zircote/swagger-php/blob/master/src/Annotations/MediaType.php

我试过encoding={"recommended"={"contentType"="multipart/form-data"}}了,但没用。

0 投票
1 回答
4277 浏览

swagger - Swagger OpenAPI 使用带有模式的对象而不是数组

我正在使用L5 SwaggerfromDarkOnLine使用 OpenApi 原理图生成 Swagger 文档。

要使用架构,我可以做

它工作得很好,并显示为

. 但它会创建一个带有方括号的数组块,其中包含多个对象。

我如何使用相同的工作但丢失数组。就像是

以便删除方括号并仅显示对象。

0 投票
1 回答
1915 浏览

swagger - 没有请求正文的 Swagger OpenAPI 发布应用程序/json

我的 API 只使用Header - Content-type:application/json对象的请求。

为此,我使用:

但是对于一些我不需要的请求RequestBody,只需点击资源并获取数据。没有我怎么办RequestBody

PS 这个请求需要一个GET方法(POST如果有帮助,可以使用),但GET不接受RequestBody.

0 投票
1 回答
10826 浏览

php - 问题'授权:承载' 在 Swagger openAPI 注释中

我使用这些包(通过作曲家安装)

“swagger-api/swagger-ui”:“^3.0”,
“zircote/swagger-php”:“~2.0|3.*”

在我的 def 控制器中,我有这些注释

然后我有方法

所以,当我尝试通过 swagger ui 测试这条路线时,我得到了错误

401,“消息”:“未经身份验证。”

当我检查标题(Firefox)时,我没有看到

授权:承载 {{access-token}}

但我有我的令牌

Cookie:XSRF-TOKEN=eyJpdiI6Ik5COUV5Y1ltRTM4eXNsRlpLY2ptTGc9PSIsInZhbHVlIjoiNDFCbG95c1RHSHRFT0IyWWZ4aWFRQVJ6RHhTS1A4SFJiQXp2amlQc3RCUFRUWWs5R3RQQ0ZlakdFNnlvRm50MSIsIm1hY...

Swagger UI 未正确发送标头。注释有什么问题?谢谢

0 投票
1 回答
5562 浏览

php - 对于 OpenAPI (swagger-php),如何自动生成查询参数?

我正在编写 OpenAPI 规范并尝试从请求路由/路径的注释中自动(使用 swagger-php)生成我可能的查询参数。我知道我可以为每条路由输入所有可能的参数选项,但我确实需要能够使用注释自动从类的属性中生成可能的参数,就像我可以为请求正文做的那样。(我们将拥有大量的类/路径,并且除非它们像请求正文/JsonContent 那样生成,否则很可能不会发生这种情况。这对于 swagger-php 甚至是一般的 OpenAPI 是否可行?

我让它与 put 和 request body 一起工作,但是对于仍然使用类属性的 get 请求,我该如何做呢?

我可以为请求正文执行此操作:

写出 30 多个类的每个参数将无法维护:

0 投票
1 回答
1346 浏览

php - Swagger 注解和 OpenAPI v3.0 中的“Produces”注解是什么?

在 OpenAPI v2.0 和 Swagger PHP 上,Produces 的注释是:

但是在 OpenAPI v3.0 和 Swagger PHP 上,我找不到如何在文档上注释产品,它指出它现在是响应的一个属性,@OA\Response但我找不到我已经尝试放置"content" = "application/json"但它不起作用的示例.

0 投票
0 回答
3015 浏览

swagger - 用于预定义示例的 Swagger-PHP 注释

我正在使用 swagger-php 注释来生成我的 REST API 的文档,并且我想使用预定义的示例来描述响应。

下面的 YAML 代码有效:

但是,当尝试通过注释生成上面的代码时,我无法让它工作。正在尝试:

到目前为止,似乎还没有关于 PHP 注释的文档。有什么建议么?

0 投票
1 回答
445 浏览

annotations - Swagger:在哪里设置授权的 API 密钥

我使用 Nelmio APi Doc 3.4。昂首阔步。我想为我的 api 使用 apiKey 授权。我将配置设置为nelmio_api_doc.yaml

在我的控制器中,我在注释中设置了参数:

但是我在哪里设置我的 ApiKey?例如,我有一个 apiKey“abc123”,我想根据插入键检查它?我不明白这个功能在哪里。有人可以帮我弄这个吗?