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

php - Swagger-PHP 模型未被读取

我目前需要使用 swagger 记录一个 php 项目。但是,它不遵循传统的 MVC 模式,而是包含获取/获取数据并返回某些内容的静态文件。

资源通常在 json 文件中创建,但是,由于某种原因,我制作的模型没有被渲染。这是我将放置在我的一个文件中的示例:

解决了这个问题模型部分总是被跳过,我无法在我的 json 文件中实现模型模式。

新问题我收到内存不足错误或招摇停止,具体取决于我的服务器:

在我的个人服务器上,当我尝试记录时,它要么滞后/停止,而且我没有看到任何错误消息(这不会发生在 Swagger-php 存储库中的示例实现中)。当我在实际服务器上时,出现内存不足错误: PHP Fatal error: Out of memory (allocated -1202716672) (tried to allocate 261900 bytes) in phar:///usr/local/bin/swagger.phar/ library/Swagger/Swagger.php 在第 668 行

关于我用来记录这一点的内容,我使用命令行中的 swagger.phar 文件。

关于如何使模型出现的任何帮助都会很棒。谢谢你。

0 投票
11 回答
161852 浏览

yaml - Converting Swagger specification JSON to HTML documentation

For some REST APIs written in PHP, I was asked to create Swagger documentation, and since I was not aware of any easy way of adding annotations to those existing APIs and create such a documentation, I used this editor to generate some for now.

I saved the JSON and YAML files created using that editor, and now I need to create the final interactive Swagger documentation (this statement might sound naive and vague).

Can someone please let me know how I can convert the Swagger JSON specification file to actual Swagger documentation?

I am on the Windows platform and do not know anything about Ant/Maven.

0 投票
3 回答
5818 浏览

php - PHP-Swagger 查询参数

在我的 Zend 应用程序中,我正在为移动应用程序编写一个小 API。为了方便移动开发人员,我正在使用 Swagger。到目前为止,除了一个 GET 请求外,一切正常。

当我在浏览器中调用 /user/messages/{sessionToken}?numMessages={numMessages}&pageNr={pageNr} 时,我得到了我想要的结果,但是当我尝试让 Swagger 执行此请求时,只传输了 sessionToken。我为 Swagger 尝试了这个注释:

有人看到我的错误吗?

欢迎任何帮助。

亲切的问候

霍尔特曼

更新:按照建议,我将两个参数类型都更改为“查询”并更改了路径:

但它没有工作。

eclipse PDT 中的 xdebug 显示:

大摇大摆的 JSON 是:

这是 /user 的输出:

错误似乎是,我的 swagger-ui 没有发送任何查询参数?这是一个只有一个查询参数 sessionToken 的示例:(由 FireBug 2.0.6 监控)

答案是:

答案是正确的,因为没有传输 sessionToken。

这个请求有效,但它不是来自 swagger-ui:

0 投票
2 回答
4783 浏览

swagger-php - 请求标头的 Swagger-php 注释

我正在使用 Slim 框架在 php 中创建一个 Restful api。使用 Swagger-php Annotations 记录 api。如何注释 api 的请求标头?

0 投票
2 回答
9943 浏览

php - 在 Codeigniter 项目中生成 REST 文档

我有一个使用 Codeigniter 并使用这个库的 REST 网络服务:https ://github.com/chriskacerguis/codeigniter-restserver

我想为此 Web 服务生成文档。我希望使用 Swagger UI 来生成此文档。但是,我没有找到任何文档如何将 Swagger 与 Codeigniter 一起使用。

使用这两种技术的唯一项目是这个,但没有一个好的文档:https ://github.com/panxp/codeigniter-swagger

有人可以粘贴使用这两种技术的示例或给我一个好的文档链接吗?当然,如果有另一个好的库来生成文档,如果它可以与 Codeigniter 一起使用,我会接受它。

0 投票
1 回答
3079 浏览

php - 如何在 PHPStorm 中自动格式化 PHP 注释

我正在处理大量包含带有 Swagger PHP 注释的 PHP 块文档的文件,但是它们没有缩进。反正有没有用空格自动格式化它们?

车削

进入

0 投票
1 回答
3212 浏览

swagger-php - Swagger PHP 对象而不是数组

模型的示例招摇标记

现在架构看起来像:

相反,我想看到的是:

现在我只能创建一个看起来与此相对相似的数组对象,但它仍然不是完整的规范。

我在这里读过类似的问题: https ://github.com/swagger-api/swagger-spec/issues/38 https://github.com/mission-liao/pyswagger/issues/18

但我还没有找到明确的答案。

0 投票
1 回答
1970 浏览

php - Swagger,注释中的 PHP 变量,for 循环

我是大摇大摆的新手,需要一些帮助;)一切都已设置好,并且可以正常工作..

我的控制器是用 for 循环自动设置的,有没有办法

大摇大摆的输出看起来像这样..

有没有办法正确地做到这一点?

0 投票
1 回答
901 浏览

php - 如何在没有作曲家的情况下添加供应商模块?

我想将一个模块 Swagger ( https://github.com/outeredge/SwaggerModule ) 添加到我的 Zend Framework 2 供应商库中。它有使用作曲家的说明,但我想在没有作曲家的情况下这样做。

谁能帮我解决这个问题?我尝试了什么:

  1. 我下载了模块并将其复制到 Vendor 文件夹,
  2. swagger.global.php将文件添加到config/autoload
  3. 添加 'SwaggerModule', 到application.config.php
0 投票
1 回答
323 浏览

php - Swagger 定义中的属性子集

我正在编写一个 API,其中有一个控制器,它发布一个新对象,将其返回并可以对其进行 PUT/PATCH 更新。问题是这两个不同动作之间的属性存在差异。例如,当我发布一个新对象时,我想确保返回它的“id”,以便它可以用于为 GET/PUT/PATCH 端点识别它。它是否通过 GET 返回并不重要(此时它只是数据的重复),但我当然不希望它通过 PUT 或 PATCH 传递,因为 id 是不可变的。

那么,以大摇大摆的方式标记它的最佳方法是什么,以便我可以拥有相同定义的不同版本?我已经看到您可以使用“allOf”将定义添加到其他属性,但我想知道是否有办法说“定义中没有这些属性”?

如果我能做到后者,我可以对整个对象进行一个定义,并简单地剔除在控制器处引用它时不需要返回或提交的东西。这可能吗?我说得有道理吗?

(只是为了让事情更有趣,我的 swagger.json 文件是由 swagger-php 基于我的控制器和实体文件中的注释生成的)