annotations - 数组对象的 Swagger PHP 注释

Question

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

从下面的代码：

@SWG\Schema(        
  @SWG\Property(property="project-name", type="string"),    
  @SWG\Property(property="project-detail", type="array",
    @SWG\Items(type="object",
        @SWG\Property(property="name", type="string", ),
        @SWG\Property(property="category", type="string",),
    ),
    @SWG\Items(type="object",
        @SWG\Property(property="new_name", type="string", ),
        @SWG\Property(property="new_category", type="string",),
    ),
  ),
),

我得到输出：

{
  "project-name": "string",
  "project-detail": [
     {
       "name": "string",
       "category": "string"
     }
   ]
}

但我想要以下一个：

{
  "project-name": "string",
  "project-detail": [
     {
       "name": "string",
       "category": "string"
     },
     {
       "new_name": "string",
       "new_category": "string"
     },
   ]
}

请帮我解决这个问题。

Answer 1

您只能在对象数组上显示一个对象。因为创建 Swagger 是为了解释您必须向 API 提供什么以及返回什么（不是必需的）。

当你在里面查看一个数组和一个对象时，你当然会理解这不是一个有 1 个对象的数组。

希望能帮助到你 ！

主'

Answer 2

通过添加示例 ex. 来修改您的项目详细信息属性。

example="{
         {
          "name": "String",
          "category": "String"
         }, 
         {
          "name": "String",
          "category": "String"
         }
        }"