Question

我正在使用Swagger创建api。我的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",
            ),
        )
    ),

如何在swagger API文档中为每个API响应数据添加描述

1 个答案: