Swagger + bearer

Всё что касается построения API
Ответить
Аватара пользователя
Ghost_nsk
Сообщения: 811
Зарегистрирован: 2012.01.01, 00:45
Откуда: Новосибирск
Контактная информация:

Swagger + bearer

Сообщение Ghost_nsk »

Товарищи, подскажите кто сталкивался. Работаю с документацией в swagger, не могу понять как подключить поле для ввода токена.

Код: Выделить всё

/**
 * Class ClientController
 *
 * @package api\controllers
 *
 * @OA\SecurityScheme(
 *   securityScheme="bearerAuth",
 *   in="header",
 *   name="bearerAuth",
 *   type="http",
 *   scheme="bearer",
 *   bearerFormat="JWT",
 * ),
 * @OA\Tag(
 *   name="client",
 *   description="Client crud methods"
 * ),
 * @OA\Post(
 *   path="/client/create",
 *   summary="Create a new client record",
 *   tags={"client"},
 *   security={"bearerAuth"},
 *   @OA\RequestBody(
 *     required=true,
 *     @OA\JsonContent(ref="#/components/schemas/Client"),
 *   ),
 *   @OA\Response(
 *     response=200,
 *     description="Success"
 *   ),
 *   @OA\Response(
 *     response=402,
 *     description="Validation error"
 *   ),
 * ),
 */

yiiliveext
Сообщения: 910
Зарегистрирован: 2019.08.13, 01:49

Re: Swagger + bearer

Сообщение yiiliveext »

Оно само выводится в swagger-ui по нажатию на кнопку Authorize
https://petstore.swagger.io/

Аватара пользователя
Ghost_nsk
Сообщения: 811
Зарегистрирован: 2012.01.01, 00:45
Откуда: Новосибирск
Контактная информация:

Re: Swagger + bearer

Сообщение Ghost_nsk »

Правильный ответ, если кому понадобится:

Код: Выделить всё

/**
 * Class ClientController
 *
 * @package api\controllers
 *
 * @OA\SecurityScheme(
 *   securityScheme="bearerAuth",
 *   in="header",
 *   name="Authorization",
 *   type="http",
 *   scheme="bearer",
 *   bearerFormat="JWT",
 * ),
 * @OA\Tag(
 *   name="client",
 *   description="Client crud methods"
 * ),
 * @OA\Post(
 *   path="/client/create",
 *   summary="Create a new client record",
 *   tags={"client"},
 *   security={
 *     {"bearerAuth": {}}
 *   },
 *   @OA\RequestBody(
 *     required=true,
 *     @OA\JsonContent(ref="#/components/schemas/Client"),
 *   ),
 *   @OA\Response(
 *     response=200,
 *     description="Success"
 *   ),
 *   @OA\Response(
 *     response=402,
 *     description="Validation error"
 *   ),
 * ),
 */

Ответить