Описание тега swagger-php
Библиотека аннотаций и синтаксического анализа php swagger
1
ответ
Swagger PHP Object вместо массива
Пример разметки для модели * @SWG\Model( * id="UserSubscriptionSearchResultsFilter", * @SWG\Property(name="total", type="integer"), * @SWG\Property(name="perPage", type="integer"), * @SWG\Property(name="query", type="string"), * @SWG\Property(name="…
24 июн '15 в 23:04
1
ответ
На схему безопасности Swagger PHP ссылаются плохо
Я использую эту SecuritySchema для определения проверки безопасности JWT: /* * @SWG\SecurityScheme( * securityDefinition="JWT", * type="apiKey", * in="header", * name="Authenticate" * ) */ И ссылаясь на это как: /* * @SWG\Post(path="/ap/some/method"…
09 фев '17 в 14:12
1
ответ
Swagger-php, как исключить всю папку /vendor, но добавить одну подпапку с общими моделями
Я использую пакет Swagger-php В настоящее время я генерирую файл swagger, выполнив: ./vendor/bin/openapi - выходное хранилище /app/swagger/swagger.json - исключить тесты - исключить хранилище - исключить поставщика./ И у меня есть несколько моделей,…
27 ноя '18 в 20:39
1
ответ
Как исключить некоторые (вложенные) свойства из моделей, используемых в @SWG\Response
Я пишу API в Php Laravel и использую аннотации swagger (2.0) (lib: darkaonline / l5-swagger, которые используют swagger-php) для генерации swagger.json. У меня есть следующее чванство: @SWG\Definition( definition="Space", @SWG\Property( property="id…
01 дек '17 в 05:19
1
ответ
Параметры пути необязательны в аннотации Swagger
Я использую эту библиотеку. Я хочу иметь необязательные параметры в моем URL например у меня есть этот маршрут $app->get('/files/{order:\d+}[/{all:0|1|all}]', 'myctroller'); И моя аннотация /** * @SWG\Get(path="/doc/v1/files/{id_ordine}/{all}", *…
20 апр '17 в 09:16
4
ответа
Могу ли я сделать использование swagger-php массивов в строке запроса?
Я использую Swagger-php. Когда я определяю параметр в строке запроса, это может быть массив. Но из того, что я вижу, он не поддерживает этот вид строки запроса: https://api.domain.tld/v1/objects?q[]=1&q[]=5&q[]=12 Я считаю, что это будет уст…
17 июн '16 в 09:31
0
ответов
Swagger-php на Yii2 ActiveController
В моем приложении yii2 запущен API REST. Я расширяю свою модель API от моей модели AR и использую fields() функция для определения полей ответа API. /** * @SWG\Definition( * type="object" * ) */ class Person extends \common\models\Person implements …
17 май '17 в 18:40
1
ответ
Как создать секцию значений модели / примера для запроса GET в Swagger
Я обеспокоен созданием раздела значения Model/Example для моего запроса GET с помощью Swagger. Ссылка на официальный пример отлично показывает этот раздел. В официальных документах он генерируется с использованием существующей модели: * @SWG\Schema(…
18 мар '16 в 17:18
1
ответ
swagger-codegen: java.io.FileNotFoundException: невозможно прочитать API
Я пытаюсь работать с swagger-codegen генерировать код на основе моего файла ресурсов Swagger. Тем не менее, я сталкиваюсь с следующей ошибкой при попытке создать код: base path is http://my.documentation.com/api/docs/v1.json java.io.FileNotFoundExce…
16 апр '14 в 16:53
2
ответа
Swagger.php: как изменить заголовок запроса POST Content-type
Я использую lib: darkaonline / l5-swagger (^ 5.5) (который содержит swagger-php + swagger-ui), мне нужно изменить Content-Type заголовка в моем POST-запросе, чтобы загрузить файл (чтобы прочитать его в Laravel Input::file('Фото')). Я прочитал, что я…
24 янв '18 в 00:43
1
ответ
Swagger php разные версии определения
Я устанавливаю Swagger для моего API, используя аннотации swagger-php. Что я не могу понять, так это как определить различные определения ресурса. у меня есть User класс, который имеет идентификатор, адрес электронной почты, пароль и телефон. Следую…
12 мар '17 в 10:54
1
ответ
Как добавить модуль вендора без композитора?
Я хочу добавить модуль Swagger ( https://github.com/outeredge/SwaggerModule) в мою библиотеку поставщиков Zend Framework 2. В нем есть инструкции по использованию композитора, но я хочу сделать это без композитора. Кто-нибудь может мне помочь с этим…
19 ноя '15 в 08:33
1
ответ
Swagger PHP - как определить вложенное свойство?
Я использую Swagger PHP, и большинство определений легко определить, но у меня проблема с конкретным фрагментом данных, который не является частью отдельного класса, а вместо этого является ассоциативным массивом. Ответ json, который я хочу показать…
20 май '16 в 09:05
0
ответов
Swagger для PHP массив массивов
Я пытаюсь создать пример ответа, который должен вернуть массив, как это: [ [ "Shop Name", "53.7094190", "-1.9084720" ,1 ] ] Для этого я использую этот код: * @OA\Response( * response= "default", * description="Success: Array of shops", * @OA\MediaTy…
14 ноя '18 в 10:34
1
ответ
Изменить URL-адрес Curl в Swagger UI
Я разрабатываю новый API с использованием Slim Framework (v3). Я пытаюсь интегрировать этот API с интерфейсом Swagger, но когда я нажимаю кнопку "Попробуйте", Swagger генерирует следующую ссылку. Пример ссылки: http://localhost/api/public/contact?pa…
19 сен '16 в 16:32
2
ответа
Как указать тело JSON по умолчанию в Swagger-PHP?
Я хочу указать тело JSON по умолчанию для запроса POST в Swagger-PHP. Мои аннотации выглядят так: /** * Setup order * * @SWG\Post( * path="/order/setup", * operationId="setupOrder", * tags={"Orders"}, * summary="Setup an order with status draft.", *…
19 апр '18 в 08:28
1
ответ
Swagger аннотации со связанным массивом свойств
Я новичок в PHP Swagger и использую пакет Laravel L5-Swagger для создания документации для моего API. Теперь я пытаюсь разрешить одной модели содержать массив другой модели, так как Order может иметь несколько OrderItems. К сожалению, я не могу полу…
15 фев '18 в 22:21
2
ответа
Два пути для одного метода
Я пытался использовать Swagger для генерации моей документации для моего PHP Rest API, используя swagger-php. Он работает довольно хорошо, не совсем уверен, что я фанат огромных блоков комментариев из-за документации, но это не проблема. У меня есть…
29 дек '15 в 02:19
2
ответа
Swagger CSV Post
Мы работаем над документацией Swagger для нашей реализации REST API Laravel. Несколько конечных точек POST будут использовать CSV в качестве типа содержимого параметра. Есть ли способ в Swagger, чтобы функция "Попробуй сейчас" работала с загрузкой ф…
09 фев '18 в 22:05
1
ответ
Передача 2-х параметров в рестлер
Я пытаюсь передать объект и строку в функцию и проверить его в рестлере,но я получаю эту ошибку: "error": { "code": 400, "message": "Bad Request: `user` is required but missing." }, в документации я написал: /** * * @param User $user user object * *…
07 окт '13 в 12:03