Как добавить описание для каждого отклика API в swagger api doc

Question

Я создаю API с помощью Swagger.Мой API работает нормально.Теперь я хочу добавить описание для всех данных, которые возвращают мой API.Предположим, вот моя функциональность API.

@SWG\POST(
    path="/api/data",
    tags={"datas"},
    summary="returns all datas",
    description="Base url  is : http://example.com/",
    @SWG\Parameter(
        name="Authorization",
        in="header",
        description="Token to access content",
        required=true,
        type="string",
        default="Bearer TOKEN",
        description="Authorization"
    ),
    @SWG\Response(
        response="200",
        description="Successful operation",
    ),
    @SWG\Response(
        response=400,
        description="Invalid Data| Data not in request"
    ),
    @SWG\Response(
        response=401,
        description="Invalid token | Header Token is missing"
    ),
)

Эта функция API возвращает данные, подобные этим:

{
 "data": [
 {
  "id": 1,
  "title": "Title of the file",
  "description": "description of file",
  "content": "content name will be here",
  "thumbnail": "content thumbnail will be here"
}
]
}

Теперь я хочу добавить описание в документации, что делает id, title, description, content & thumbnail значит?Проще говоря, я хочу добавить небольшое описание для них.Я попытался добавить $ref и describing responses.Но это не работает.Почти каждый раз, когда я получаю ошибку, как это failed to parse JSON/YAML response.Пожалуйста помоги мне с этим.Спасибо

Answer 1

Вот так я решил проблему.

@SWG\Response(
        response="200",
        description="Successful operation",
        @SWG\Schema(
            @SWG\Property(
                property="title = file title",
            ),
            @SWG\Property(
                property="description = file description",
            ),
            @SWG\Property(
                property="name= file name",
            ),
        )
    ),