Описание тега nelmioapidocbundle

Описание тега Вопросы с тегом
Пакет NelmioApiDocBundle позволяет вам создавать достойную документацию для ваших API.
0 ответов

NelmioApiDocBundle не работает "В спецификации не определены операции!" Symfony 3.4

Я хочу настроить nelmio для моего проекта Symfony 3. Я установил пакет, но в конце я получаю сообщение об отсутствии определенных операций!!!! Что не так? Есть идеи? /** * List the rewards of the specified user. * * This call takes into account all …
14 янв '19 в 17:50
0 ответов

Как установить, что значение параметра может быть нулевым в nelmio api doc?

У меня есть API в Symfony Flex, который задокументирован с использованием NelmioApiDocBundle. В документации я хочу показать, что parentPOSId Параметр может быть int или null. Как мне это сделать? Это мои аннотации контроллера: /** * * @FOSRest\Post…
19 фев '19 в 09:51
3 ответа

NelmioApiDocBundle не генерирует документацию

Я хочу использовать NelmioApiDocBundle для автоматического создания документации. Я использовал стандартный документ Symfony для его установки и настройки: https://symfony.com/doc/current/bundles/NelmioApiDocBundle/index.html. К сожалению, когда я з…
01 июн '18 в 13:48
0 ответов

Параметр Nelmio API Doc Array

С точки зрения Symfony 4, используя Swagger\Annotationsкак я могу определить запрос Parameter как массив? q[a]=1&q[b]=foo Я делал это с помощью Symfony 2 несколько лет назад и не могу ни вспомнить, ни найти в Google... Пожалуйста, совет
12 сен '18 в 13:08
2 ответа

Есть ли способ использовать несколько файлов YML с Nelmio_api_doc в Symfony 3 с NelmioApiDocBundle?

NelmioApiDocBundle позволяет использовать только один файл конфигурации в качестве.yml. nelmio_api_doc: routes: path_patterns: # an array of regexps - ^/api documentation: paths: /api/login_check: ... /api/refresh_token: ... Но у меня есть более 200…
23 ноя '17 в 07:45
0 ответов

Значение параметра ресурса в параметре doc API Nelmiobundles

Какое значение имеет параметр ресурса в аннотации APIDoc от NelmioBundle? Он принимает логическое значение ( https://symfony.com/doc/2.x/bundles/NelmioApiDocBundle/the-apidoc-annotation.html). Может ли кто-нибудь объяснить точный вариант использован…
07 ноя '18 в 08:17
0 ответов

Расширение документа Swagger 2.0 со значениями из базы данных (NelmioApiDocBundle 3.2)

У меня есть запрос API с предопределенными значениями, которые могут быть приняты (статусы). Есть ли способ добавить в документацию Swagger UI список со статусами, полученными из базы данных? Таким образом, когда новый статус добавляется или изменяе…
06 авг '18 в 14:30
1 ответ

Определение модели NelmioApiDoc / как игнорировать геттер или псевдоним существующего свойства с другим именем?

Можем ли мы переопределить имя свойства аксессора модели или проигнорировать его? Вот мой User::getUsername функция, которая является геттером для свойства электронной почты (мне нужна эта функция, названная так, чтобы реализовать интерфейс): class …
17 май '18 в 15:07
0 ответов

Я использую NelmioApiDocBundle для документирования своего API. Как применить проверки в аннотациях?

Поэтому я использую NelmioApiDocBundle для документирования своего API в формате swagger. Когда я захожу на mydomain.com/api/doc, я вижу документацию, и это нормально. Но, например, я устанавливаю параметр запроса (test_query1) как требуется, и когд…
08 янв '19 в 12:14
2 ответа

Нераспознанная опция "Области" в NelmioApiDocBundle Symfony3.4

Я хочу создать документацию по пользовательскому интерфейсу с swagger для моего Restful API. это официальная документация для этого https://symfony.com/doc/master/bundles/NelmioApiDocBundle/index.html Но я получил эту ошибку Unrecognized option "are…
05 май '18 в 08:24
0 ответов

Поддерживает ли nelmioApiDocBundle нормализаторы сериализатора Symfony и преобразователи имен?

Я работаю над Symfony 3.4 API. Я хочу сгенерировать документацию для API, используя nelmioApiDocBundle v3.2, но я сталкиваюсь с некоторыми препятствиями. Для сериализации и нормализации я использую сериализатор Symfony, но я не могу заставить nelmio…
26 май '18 в 17:03
2 ответа

NelmioApiDocBundle не работает "Нет операций, определенных в спецификации!"

Я хочу использовать nelmio для symfony-project, но это не работает. Это всегда говорит: никаких операций не определено в спецификации! Я также пробую пример на https://symfony.com/doc/current/bundles/NelmioApiDocBundle/index.html Что не так? Есть ид…
05 сен '18 в 07:59
0 ответов

Symfony NelmioApiDocBundle swagger-ui PHP Аннотации объекта json с массивом свойств объектов не отображаются

Я пытаюсь опубликовать JSON с NelmioApiDocBundle, у меня есть пример JSON, но свойства объекта массива не отображаются в примере попробовать его? Я попробовал несколько методов для достижения этой цели без успеха. Ниже приведен код, который я пробов…
21 авг '17 в 18:48
1 ответ

Конфигурация Symfony jmsserilaizerbundle не работает

Я хочу создать свой собственный API отдыха с использованием Symfony PHP Framework. причины, я использую - FOSRestBundle- FOSUserBundle- LexikJWTA Аутентификация Bundle- JMSSerializerBundle После настройки всех пакетов мой API возвращает пустые объек…
14 авг '18 в 14:25
0 ответов

Опция "form_errors" в новой версии nelmio api doc

В предыдущей версии Nelmio api doc я использовал: /** * @ApiDoc( * description = "Registers a new user", * section = "User", * https = true, * authentication = false, * input = { * "class" = RegistrationType::class, * "name" = "" * }, * statusCodes …
03 окт '18 в 14:15
0 ответов

NelmioApiDocBundle: генерировать документацию в конвейере сборки

В проекте, построенном с использованием Symfony 4, мы используем NelmioApiDocBundle версии 3 плюс аннотации Swagger, что прекрасно работает. Помимо просмотра документации по API, я хотел бы создать статическую версию документации, которая будет сген…
23 мар '18 в 11:12
1 ответ

Отключение песочницы для NelmioApiDocs в Symfony 3.4

Я хочу отключить режим песочницы для NelmioApiDocs в Symfony "v3.4.11" и nelmio/api-doc-bundle "v3.2.1" Я пробовал: # app/config/config.yml # nelmio_api_doc nelmio_api_doc: documentation: sandbox: enabled: false После этого я очистил кеш для prod и …
05 июн '18 в 13:16
5 ответов

Как отключить интерфейс Nelmio в производстве?

Есть ли способ отключить все документы по интерфейсу пользователя Nelmio Swagger? В производственном процессе я хочу, чтобы внешний мир ничего не видел по следующим URL, но в dev они должны отображать полезные документы и песочницу как обычно: http:…
08 ноя '16 в 19:40
1 ответ

Написание документации Swagger для запросов в теле без ссылки на модель

Как написать документацию Swagger для запросов в теле без ссылки на модель? например: @SWG\Parameter( name="date", in="body", content="application/json", type="object", {custom written JSON} ) Я попытался сделать это в описании, но это не сработает,…
01 дек '18 в 21:45
0 ответов

Получение исключения со статусом 406 на NelmioApiDocBundle

Я установил и настроил NelmioApiDocBundle за Symfony 3.4.3 в соответствии с этим документом: https://symfony.com/doc/master/bundles/NelmioApiDocBundle/index.html И получить исключение со статусом 406 для файлов jel, css и изображений NelmioApiDocBun…
09 фев '18 в 13:41