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

php - 将鉴别器与 allOf 一起使用

我正在尝试使用swagger-php v2.0记录一个 api 端点,但未正确生成 swagger 文档。

我的用例是我需要从同一个端点接受 2 个不同的有效负载,并且某些键只能存在于给定的上下文中。

至于官方文档,它可以使用discriminatorwith来实现allOf这是OpenAPI (Swagger) Specification 中给出的示例。

为清楚起见,我将在此处发布缩小版本

我想将其转换为 swagger-php,我想出的方法如下,但似乎不正确。求建议改正,谢谢。

0 投票
2 回答
6049 浏览

php - 配置 Swagger UI 路由

我想使用 swagger 来记录 laravel API,并让用户使用与petstore.swagger.io

这是我使用swagger-php&l5-swagger包所采取的步骤

  1. 作曲家需要 zircote/swagger-php
  2. 作曲家需要darkaonline/l5-swagger
  3. 添加L5Swagger\L5SwaggerServiceProvider::class,到 config/app.php 文件
  4. 向 BookController 添加注释
  5. 运行命令php artisan l5-swagger:generate

然后我像这样向 BookController 添加注释

此时我不知道在加载 swagger UI 以查看 API 文档时使用什么 url。这是目前唯一让我在编码挑战中退缩的事情,所以我有点急需帮助。

0 投票
1 回答
163 浏览

swagger - 在 Linux Centos 7 中安装 swagger-php 和 Composer

我正在尝试查找在 Linux Centos7 中安装 swagger-php 和 Composer 的步骤。

0 投票
0 回答
28 浏览

swagger - 如何在 swagger-php 中删除请求正文示例下拉列表

我正在使用Swagger 3.0swagger-php获得

请求正文标记的奇怪行为

.

在图像中,“示例:”下拉菜单出现,“示例值 | 架构”显示在该下拉列表下方,而不是“示例值 | 模型”。

我的问题是:

  1. 如何删除示例下拉列表?

  2. 如何为下拉列表添加多个示例?

  3. 为什么我的sagger-ui show“示例值 | 架构”而不是“示例值 | 模型”?

  4. 是否有未列出的有关请求正文示例的更新文档?

我正在关注第 40 行的帖子示例

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/controllers/User.php

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/models/RequestBody.php

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/models/User.php

这是我的标记:

示例下拉图片

0 投票
1 回答
849 浏览

openapi - 在 Swagger OpenAPI 注解中定义数组

我正在使用带有 OpenAPI 3.0 的 Swagger Editor,并且我安装了 swagger-php 库。现在我有一个 php 函数,其参数之一为数组,例如:

如何编写此数组的注释以调用此函数。

0 投票
1 回答
2379 浏览

swagger - Swagger-php 在每个模型属性上添加一个“模式”属性

(这是我的第一个堆栈溢出帖子,所以请放轻松,哈哈)

我正在使用:
-OpenApi (v3)
-L5-Swagger(swagger-php 和 swagger-ui 的包装器)

我正在使用注释来生成 OpenAPI 规范。正在从控制台生成规范,没有错误。但是,在每个模型的每个属性中,一旦生成,就会添加一个附加属性。

我尝试过:
1. 重写模型,
2. 以不同方式重写属性

我的模型之一和“id”属性:

这是正在生成的内容:

我在做什么,正在生成一个“模式”属性?

当我将规范文件放入 Swagger 编辑器时,它说 ActionPlan.properties.id 不应该有其他属性。附加属性:模式。

我只是想知道创建“模式”属性发生了什么。

提前致谢!

0 投票
1 回答
783 浏览

php - 如何在我的 Core PHP 项目中为现有 API 集成 Swagger?

像 Laravel 或 Cake PHP 这样的框架已经支持,但我有我的旧核心 PHP 项目,我需要为其现有的 API 实现 Swagger。请建议我,因为它的文档非常难以面对。

0 投票
2 回答
3326 浏览

annotations - 数组对象的 Swagger PHP 注释

我想在 api/doc 视图中包含对象数组。但我无法得到那个。

从下面的代码:

我得到输出:

但我想要以下一个:

请帮我解决这个问题。

0 投票
1 回答
629 浏览

swagger - 从 Lumen REST API 生成 Swagger API 文档

我在 lumen 5.5.* 中创建了一个 REST API。现在我需要为它创建一个 swagger API 文档,但我不想为每个 API 编写注释。

任何解决方案

0 投票
2 回答
3172 浏览

php - 如何解决 php 7.4 中的 l5-swagger 问题-“尝试访问 bool 类型值的数组偏移量”?

我正在使用 php 版本 7.2,但现在升级到 7.4 在生成 l5-swagger 时出现问题。我读了这个对我不起作用的stackoverflow qauestion