问题标签 [swagger-php]

我想通过 $_POST (formData) 在我的 api 中接收这样的数组：

.

当我使用邮递员时，我可以这样做，所以我的代码没有问题，但现在我想使用 swagger，这就是我无法让它工作的地方。

我试过了

但问题是我得到一个包含多行的字段，当我用以下内容填充时：你好你好

这导致以下请求：

结果：

我知道使用此选项我无法接收带有变量键的数组（因为我无法填写键），但据我所知，这甚至不是一个数组招摇会发送带有否决参数的错误请求。

该怎么办？我希望有一个人可以帮助我

附言。我也尝试过数组中的数组，但这具有相同的结果

我正在使用这个库。我想在我的网址中有一个可选参数

例如我有这条路线

我的注释是

使用 Chrome 和这个插件，我可以用我的文档做 CURL。如果我选择所有值为 0 我的卷曲就像

我想要一个像

我在我的 yii2 应用程序中运行了一个 REST api。我从我的 AR 模型扩展了我的 api 模型，并使用该fields()函数来定义 api 响应字段。

我的活动控制器是最简单的实现

到目前为止，一切正常。然后我想添加 Swagger-php 来记录我的 API：我使用https://packagist.org/packages/light/yii2-swagger。配置有效，我有我的 swagger-ui 页面/json。

下一步是开始添加文档...但是在所有 Swagger-php 示例或https://github.com/lichunqiang/yii2-swagger-demo上，注释都在模型字段和控制器方法上。问题在于，由于 ActiveRecord 和fields()函数，这些在代码中没有明确显示。

有没有办法结合 swagger-php 和 ActiveController？

问题如下：我有一个 API，当然每个端点在成功调用的情况下都有特定类型的响应。但是当发生错误时，所有端点共享相同类型的响应。例如，当请求包含无效参数时，每个端点都会返回一个 400 状态代码，其中包含描述问题的特定内容。对于身份验证或授权问题也是如此。我试图将共享响应放入应用程序的入口点，它们位于生成的 swagger.json 中，但它们与端点无关。我希望所有端点都包含所有共享响应及其特定响应。我可以通过简单地解析 json 并通过脚本添加响应来做到这一点，但我虽然必须有更好的方法来做到这一点。

这是一个示例操作文档以防万一：

最后两个响应可以声明给我当然要避免的所有端点

我正在使用 swagger-php 为使用 Yii2 构建的 REST API 创建文档。此外，我正在使用 Yii2场景功能，这意味着我可以将同一模型重复用于多种用途。作为示例，请考虑以下用户类的最小示例：

Swagger 定义现在将包括所有字段，但只有username并且login_password将是必需的。相反，我需要的是与定义的场景匹配的两个不同定义。在此示例中，这将是：

• 定义UserLogin包括字段username和login_password
• 定义UserCreate包括字段username和名字`
• User包括所有字段的定义

如何使用 swagger-php 实现这一目标？

我正在将 Swagger 用于文档。从注释生成 json 文件效果很好。此外，我想以编程方式向生成的 json 文件添加更多路径。

我发现 Swagger 类具有合并方法，所以我尝试反序列化我的 json 字符串并合并到如下所示的 Swagger 对象中，但没有运气。

我不知道我做得对。有人用过 Swaggermerge方法或mergeProperties方法吗？还是有其他方法可以实现我的目标？

我想在某处写一个@SWG\Definition 并在@SWG\Response 注释中的@SWG\Schema 中引用它，以便在我的Symfony 3 应用程序中进行多个REST API 操作。我正在使用 Nelmio 的 api-doc-bundle 的 dev-master 版本，但我似乎可以找到任何暗示该定义应该去哪里的东西。Swagger-PHP 文档敦促尽可能不要重复，我想遵循该建议。有什么提示吗？

我正在使用带有 PHP Annotations 的 Swagger v.2，现在我在请求正文中遇到了一个“示例”的小问题。

在我的控制器中，它看起来像这样：

根据某些条件，我需要有不同的 Schema 示例，这就是为什么我希望在单独的 json 文件中以这种方式引用的 Schema 示例说明。我从这个链接得到了这个想法。

但是，这不起作用，我得到The annotation "@Swagger\Annotations\Example" doesn't exist错误。如果有人知道应该如何使用注释修复它，我们将不胜感激。

谢谢

我在 Php Laravel 中编写 API 并使用 swagger (2.0) 注释（lib: darkaonline/l5-swagger使用swagger-php）来生成 swagger.json，但是我有以下问题 - 当我输入时：

并尝试生成 swagger.json 我得到：

但是当我不使用方括号时，例如：

然后一切都很好。但是我需要使用方括号，所以问题是：

[swagger注释中json字符串中（方括号）的转义字符是什么？

我还想补充一点，我的示例 json 很大很复杂

我在 Php Laravel 中编写 API 并使用 swagger (2.0) 注释（lib: darkaonline/l5-swagger使用swagger-php）来生成 swagger.json。我有以下招摇：

上面的 api 应该返回Spaces 列表（显示在表中），但我只需要获取id和name - 但是Space也有非常重的字段dataA和dataB - 在表中不需要这些字段。有没有办法在不为响应创建单独的空间定义的情况下排除这些字段（以避免违反“不要重复自己”规则）？是否有一些机制可以做这样的事情：

和/或排除更多嵌套字段，例如

?

PS：我在这里也将其报告为问题/问题。