swagger - Swagger で GET リクエストのモデル/サンプル値セクションを生成する方法

Question

Swagger を使用した GET リクエストの Model/Example 値セクションの生成に関心があります。 公式の例へのリンクは、そのセクションを完全に示しています。

公式ドキュメントでは、既存のモデルを使用して生成されます。

     *     @SWG\Schema(ref="#/definitions/User")

プロパティは REST によって生成されるため、そのようなオプションはありません。

私は次の方法を試しました：

/**
 * @SWG\Get(
...
 *     @SWG\Response(
 *         response="200",
 *         description="Ok",
 *         @SWG\Schema(
 *             type="array",
 *             @SWG\Property(property="firstname", type="string", example="Steven")
 *         ),
 *     ),
 * )
 */

機能しておらず、次のように答えています。

fetching resource list: http://localhost/dist/swagger.json; Please wait.

どんな助けでも大歓迎です。前もって感謝します。

Answer 1

例のGET /pet/findByStatus1 つで生成されます:
github.com/zircote/swagger-php/.../Examples/petstore.swagger.io/controllers/PetController.php

スニペットが機能しない理由は、arrayサポートされていないタイプにプロパティを追加しているためです。

@SWG\Items配列の内容を説明するには、注釈が必要です。

...
 *         @SWG\Schema(
 *             type="array",
 *             @SWG\Items(
 *                 type="object",
 *                 @SWG\Property(property="firstname", type="string", example="Steven")
 *             )
 *         ),
...