昂首阔步的OpenAPI使用带有模式的对象而不是数组

Question

我正在使用DarkOnline中的L5 Swagger使用OpenApi示意图生成Swagger文档。

要使用模式，我可以做

@OA\Property(property="certification", type="array", @OA\Items(ref="#/components/schemas/Certification"))

它工作得很好，表现为

"certification": [
    {
      "certification_id": 0,
      "name": "string"
    }
  ],

.但是它创建了一个带有方括号的数组块，其中包含多个对象。

我如何使用相同的工作，但失去数组。类似于

@OA\Property(property="certification", type="object", @OA\Items(ref="#/components/schemas/Certification")),

以便移除方括号并只显示类似的对象。

"certification": {
      "certification_id": 0,
      "name": "string"
 }

Answer 1

你可以做：

@OA\Property(
  property="certification", 
  ref="#/components/schemas/Certification"
)

@oa\items注释仅在希望指定数组中的属性时使用（请参见Data Types：array）。

在您的示例中，您只想描述一个对象，因此只需在属性中引用对象的模式，并移除@oa\items。