Как добавить еще один параметр в документации API Swagger

Question

Я создаю документацию по API, используя swagger. Я создал 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. Подробнее об этом см. В документах Swagger-PHP и в основных документах Swagger .