Question

我正在使用swagger创建API文档。我已经创建了API。在一个api中，我有音频。该API返回音频文件名。现在，我想在文档中添加音频路径，以便API用户可以播放音频。就像，我正在返回一个名为song.mp3的音频文件。要播放此音频API，用户需要此文件的完整路径。像example.com/audio/song.mp3。 example.com是站点名称。 audio是存储song.mp3的文件夹名称。

这就是我创建API的方式。

<?php
/**
@SWG\Post(
    path="/api/audios",
    tags={"audios"},
    summary="returns all audios",
    description="This resource represents an individual user in the system.
    Each user is identified by a numeric",
    resourcepath = "store",
    @SWG\Parameter(
        name="Authorization",
        in="header",
        description="Token to access Audio File",
        required=true,
        type="string",
        default="Bearer TOKEN",
        description="Authorization"
    ),
    @SWG\Response(
        response="200",
        description="Successful operation",
    ),
    @SWG\Response(
        response=400,
        description="Invalid Code | Code not in request"
    ),
    @SWG\Response(
        response=401,
        description="Invalid token | Header Token is missing"
    ),
)

@SWG\Post(
    path="/api/audios/{audioId}",
    tags={"audios"},
    summary="returns single audio",
    @SWG\Parameter(
        name="Authorization",
        in="header",
        description="Token to access Audio File",
        required=true,
        type="string",
        default="Bearer TOKEN",
        description="Authorization"
    ),
    @SWG\Parameter(
        name="audioId",
        in="path",
        description="Id of Audio File",
        required=true,
        type="string",
        default="123"
    ),
    @SWG\Response(
        response="200",
        description="Successful operation",
    ),
    @SWG\Response(
        response=404,
        description="Audio not found"
    ),
    @SWG\Response(
        response=401,
        description="Invalid token | Header Token is missing"
    )
)
*/

我只需要在适当的位置添加example.com/audio，以便API用户可以理解此音频存储在此目录中。

Answer 1

您可以在状态码为200的响应中定义它。有关更多信息，请参见the Swagger-PHP docs和the main Swagger docs。

如何在swagger API文档中添加更多参数

1 个答案: