124得票13回答
将Swagger规范的JSON转换为HTML文档

有些用PHP编写的REST API,我被要求创建Swagger文档。由于我不知道如何注释这些现有的API并创建这样的文档,因此我使用了这个编辑器来生成一些。 我保存了使用该编辑器创建的JSON和YAML文件,现在我需要从中创建“交互式”Swagger文档。 请问有人能告诉我如何将Swagger...

23得票2回答
使用SLIM和SWAGGER编写RESTful API文档?

我是一个新手,但我喜欢它。我用Slim框架创建了一个小型的REST API。现在我想要一份持续的关于它的文档。我认为Swagger是正确的选择,但我还没有弄清楚如何集成它? 祝好 & 感谢您的耐心 :)

10得票2回答
在 Codeigniter 项目中生成 REST 文档

我有一个使用Codeigniter框架构建的REST Web服务,并使用这个库:https://github.com/chriskacerguis/codeigniter-restserver。 我想为这个Web服务生成文档。我想使用Swagger UI生成这个文档,但是我没有找到如何在Co...

10得票1回答
Swagger PHP - 如何定义嵌套属性?

我正在使用Swagger PHP,大多数定义很容易定义,但是我遇到了一个问题,那就是某个特定数据不是单独类的一部分,而是一个关联数组。 我希望展示的JSON响应(简化为此问题):{ "id": 1, "status": "published", "gps": { "lat": "0....

10得票1回答
如何修复ErrorException: @OA\Property() 的类型为 "array" 时需要@OA\Items()的错误?

我试图添加一个任意类型的嵌套数组。 这是我的注释: * @OA\Property( * @OA\Schema( * type="array", * @OA\Items( * type="array", * ...

10得票2回答
如何为swagger-php OpenAPI添加接受application/json头部信息

我使用的是L5-Swagger 5.7.*包(Swagger-php的封装),并尝试描述Laravel REST API。所以,我的代码如下: /** * @OA\Post(path="/subscribers", * @OA\RequestBody( * @O...

9得票1回答
如何在PHPStorm中自动格式化PHP注释

我正在处理许多包含Swagger PHP注释的PHP代码块文档,但它们没有缩进。有没有自动添加空格格式的方法? 转换中... /** * @SWG\Api( * path="/building/{buildingId}", * @SWG\Operation( * method="G...

9得票1回答
在Swagger OpenAPI注释中,如何表示“Authorization: Bearer <token>”?

我使用这些包(通过composer安装) "swagger-api/swagger-ui": "^3.0", "zircote/swagger-php": "~2.0|3.*" 在我的def控制器中,我有这些注释 /** * @OA\Info(title="My API", v...

7得票7回答
我能让swagger-php使用查询字符串上的数组吗?

我使用Swagger-php。当我定义一个在查询字符串中的参数时,它可以是一个数组。但据我所见,它不支持这种类型的查询字符串: https://api.domain.tld/v1/objects?q[]=1&amp;q[]=5&amp;q[]=12 我相信如果可能的话,这应该会设置在 c...