如何在swagger-php中删除请求正文示例下拉列表

时间:2019-07-26 14:21:31

标签: swagger swagger-ui swagger-php swagger-3.0

我将Swagger 3.0swagger-php配合使用,并且在请求正文标记中得到

奇怪的行为。

在该图像中,出现了“示例:”下拉列表,并且在该下拉列表下方显示了“示例值|模式”,而不是“示例值|模型”。

我的问题是:

  1. 如何删除示例下拉列表?

  2. 如何为下拉菜单添加多个示例?

  3. 为什么我的sagger-ui show“示例值|模式”而不是 “示例值|模型”?

  4. 是否存在未列出有关请求正文的更新文档 例子?

我正在

的第40行上的帖子示例

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/controllers/User.php

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/models/RequestBody.php

https://github.com/zircote/swagger-php/blob/master/Examples/petstore-3.0/models/User.php

这是我的标记:

/**
* @OA\Post(
*     path="/exampleUrl/{y2k}",
*     description="Description",
*     summary="Summary",
*     @OA\Parameter(
*         name="y2k",
*         in="path",
*         description="Parameter Description",
*         required=true,
*         example="bbop",
*         @OA\Schema(
*           type="string",
*         )
*     ),
*     @OA\RequestBody(ref="#/components/requestBodies/RequestBodyExample"),
*     @OA\Response(
*         response="200",
*         description="Response Description",
*     ),
* )
*/

/**
* @OA\RequestBody(
*     request="RequestBodyExample",
*     description="Request Body Description",
*     required=true,
*     @OA\JsonContent(ref="#/components/schemas/SchemaExample"),
* )
*/

/**
* @OA\Schema()
*/
class SchemaExample
{
    /**
     * @var string
     * @OA\Property()
     */
    public $exampleString;

}

Examples dropdown image

0 个答案:

没有答案