Swagger SWG 2.x аннотация для тела запроса с несколькими параметрами - PullRequest
Новая
       29

Swagger SWG 2.x аннотация для тела запроса с несколькими параметрами

0 голосов
/ 30 января 2019

Я хотел показать тело запроса образца в swagger-ui.Я попытался добавить пример JSON-объекта запроса с помощью аннотаций SWG 2.x в моем PHP Lumen API.Мне нужно добавить нижеупомянутый объект JSON в тело запроса. 

{
    "request-body": {
        "date": "09 Feb 2019",
        "country": "XX",
        "type": "sample",
        "info": {
            "xyz": 1,
        },
        "test_internal": "abc"
    },
    "doc": {
        "comments": "contains",
        "name": "startup",
        "test_list": [
            {
                "level": "NA",
                "time_limit": "NA"
            }
        ],
        "test_list2": [
            {
                "level": "NA",
                "type": "XYZ"
            }
        ]
    }
}

Я пытался добавить вышеупомянутый объект, как это, используя аннотацию SWG. 

/** @SWG\Post(
     *     path="/test",
     *     produces={"application/json"},
     *     tags={"Test"},
     *     @SWG\Parameter(
     *         name="body",
     *         in="body",
     *         required=true,
     *         @SWG\Schema(
     *              @SWG\Property(
     *                 property="request-body", type="object", example={"date": "09 Feb 2019","country": "XX","type": "sample","info": {"xyz": 1,},"test_internal": "abc"}         *              ),
     *              @SWG\Property(
     *                 property="doc", type="object", example={"comments": "contains","name": "startup"},
     *                @SWG\Property(
     *                   property = "test_list",
     *                   type = "array",
     *                   @SWG\Items(
     *                       @SWG\Property(property="test_list", type="object", example={"level": "NA","time_limit": "NA"}),
     *                   ), 
     *                ),
     *              ),
     *         ),
     *     )
     * )
     **/

Но я получаю выводнапример, 

{
    "request-body": {
        "date": "09 Feb 2019",
        "country": "XX",
        "type": "sample",
        "info": {
            "xyz": 1,
        },
        "test_internal": "abc"
    },
    "doc": {
        "comments": "contains",
        "name": "startup"
    }
}

Как определить вложенный массив и объекты в SWG-аннотациях?

...