问题标签 [swagger-php]

我正在尝试在我的 CakePHP 项目中使用Swagger-PHP ，但遇到了一些问题。有没有人设置这个？你有什么建议吗？我已经通过 Composer 成功安装了 swagger-php，它已加载到我的控制器中（见下文）。我正在尝试通过 Web 视图呈现规范，但我不太确定为什么没有填充注册表，或者是否需要填充。

以下是 ApiController.php 内部

结果

所以，基本上 $swagResults 是空的，我猜这不应该是，对吧？

我正在尝试将一个对象和一个字符串传递给函数并在restler中对其进行测试，
但是我收到了这个错误：

在我写的文档中：

这是功能：

我正在使用restler的最新版本。

我正在尝试将 Swagger-ui 用于由 php 编写的 json-rpc 服务器。我使用Swagger-PHP为 Swagger-ui 生成 json 投诉容器。所以，我对 Swagger 很陌生，我对这样的方法使用注释：

在 SWG\Operation 中，我需要添加一个与 json-rpc spec对应的“方法” 。因此，所有请求都将使用 POST 方法作为 http 的一部分，而 json 容器将为每个请求都有自己的“方法”。

问题 - 我应该从哪里开始寻找解决这个问题？

对不起我的英语不好。不是本地人。

我正在为我们构建的 API 实现 Swagger-PHP。

这是一个简短的回顾：

语言：PHP5.3

框架：FuelPHP 1.5.3

环境：本地（使用 Nginx 服务）

现在我有一个定义如下的 API 方法：

我现在尝试以下（从我的应用程序的其他地方）来生成 JSON：

这里的第一行（在实例化我的 Swagger 类时）给我一个错误：

ErrorException [用户警告]：[语义错误]“包”类未使用@Annotation 进行注释。你确定这个类可以用作注释吗？如果是这样，那么您需要将@Annotation 添加到“包”的类文档注释中。如果确实是没有注解，那么需要在@Swagger\Annotations\Api 类的类文档注释中添加@IgnoreAnnotation("package")。

添加@IgnoreAnnotation("package")实际上没有帮助。

我注意到如果我@package从这里删除，错误就会消失：

https://github.com/zircote/swagger-php/blob/master/library/Swagger/Annotations/Api.php#L28

但这不是解决方案。

我猜这主要与教义有关，但我似乎无法弄清楚。

感谢您提供有关此问题的任何提示或想法。

我正在使用 Swagger-php 和 Swagger-UI，这一切都很好，但有一个烦恼。Swagger-UI 创建的 UI 具有我的 API 路由的预期点击展开部分，但每个部分的标题似乎是生成的 JSON 文件，而不是我可以给它的任何名称。在标题之后，描述是我在注释中给出的，但标题我似乎无法控制。

因此，如果我的路由以 /foo 的 resourcePath 开头，并且描述为“Foo API Functions”，则 UI 如下所示：

foo.json : Foo API 函数

我不想要“foo.json”，我更愿意指定它的含义。就像只是“Foo”甚至“Foo Functions”，然后将我的描述更改为更有意义的内容，例如“这是你找到 foo 函数的地方”。

我是否缺少为此使用的注释？

我正在尝试swagger-codegen根据我的 Swagger 资源文件生成代码。但是，我在尝试生成代码时遇到了以下错误：

似乎swagger-codegen试图通过在 之后附加操作名称来读取方法定义v1.json，但我不确定为什么，因为操作名称是在其内部定义的v1.json：

我不完全确定swagger-codegen期望什么格式。API 的 basePath 和 API 的文档是否需要相同？请注意，文档的文档托管在与 API 本身不同的 basePath 上。我不确定这是否重要。

我还会注意到我的 swagger 资源文件v1.json是swagger-php使用swagger-ui.

我对这些东西很陌生，但我喜欢它。我使用 Slim 框架制作了一个小 REST Api。现在我想要一份关于它的持续文档。我认为 swagger 是正确的选择，但我还没有找到如何整合它？

干杯并感谢您的耐心:)

我正在尝试使用 Slim 编写一个小 Api。我想让它记录得很好，所以我安装了 swagger-php 和 UI 并在最后几天对其进行了调查。出于某种原因，我的 petstore 演示缺少所有帖子注释。我的 API 将如下例所示：

http://coenraets.org/blog/2011/12/restful-services-with-jquery-php-and-the-slim-framework/

addWine() 函数的招摇注解会是什么样子？我如何注释函数的结果（最后插入 id），因为它不是模型？

一个例子真的很棒。谢谢

我搜索了一下，发现我已经迷路了一整天，我觉得我在兜圈子。

我已经为我的基于 Yii 的应用程序编写了一个简单的 API（在一些指南的帮助下）。

我现在来记录这个 API 以供其他人使用。我到处读到 Swagger 似乎是实现 API 文档的方法。但是，我似乎可以在任何地方了解如何使用此应用程序

我已按照Swagger PHP上的说明进行操作， 现在我迷路了，有没有人知道下一步该做什么。

我尝试对我的 ApiController.php 做一些自我注释，但这不起作用。我一直在尝试使用 swagger.phar 命令行，但我仍然无处可去。我知道您将需要更多信息，但我不知道您需要哪些信息，所以不要粘贴大量无用的信息，请询问，我会发送您需要的任何信息。

老实说，我想要的只是一些简单的 API 文档，但这似乎是不可能的。

干杯

目前对于一个项目，我需要使用 Swagger 为其创建文档。由于项目是用 php 完成的，所以我将使用 Swagger-Php 来注释代码并创建文档。现在我注意到，在所有示例项目中，它们都是面向对象的；换句话说，当发出请求时，会调用控制器，然后调用模型等。在我参与的项目中，项目不是这样组织的：每个页面都有自己的文件, 并负责该文件中的所有操作。我将如何使用 Swagger 以这种方式记录代码？

例如，下面的伪代码本质上就是每个文件的作用：

我会做这样的事情吗？

感谢您的任何帮助。