Описание тега nelmio-api-doc
Пакет NelmioApiDocBundle позволяет генерировать достойную документацию для ваших API.
2
ответа
Групповое исключение в Nelmio Api Doc не работает После обновления композитора
Я настроил параметр в виде массива, как описано в http://jmsyst.com/libs/serializer/master/reference/annotations class QuestionAnswer { /** * @JMS\Type("ArrayCollection<Rest\Bundle\Entity\Fixture\QuestionOptions>") * @Groups({"QuestionAnswer"}…
05 мар '15 в 08:33
0
ответов
Веб-страница NelmioApiDocBundle показана в примере значения "Неизвестный тип: DateTime"
Настроить nelmio-bundle.yaml myType: description: .... type: DateTime example: "2020-08-16" на веб-странице раздела "Пример значения" показать мне это { "id": "string", "someField": "Unknown Type: myType", } на странице php im используя эту аннотаци…
23 июн '18 в 13:06
1
ответ
Комплект документов Nelmio Api: документирование необходимых параметров
В настоящее время я работаю с NelmioApiDocBundle, с которым я еще не очень знаком. API, который я пишу, должен предоставить маршрут для изменения пароля конкретного пользователя. В документации должно быть указано, что для смены пароля требуется как…
31 авг '15 в 10:06
1
ответ
Как заставить NelmioApiDocBundle работать с FormType Symfony
Поработав некоторое время с FOSRestBundle, я чувствую, что что-то упустил. На мой взгляд, FOSRestBundle и Symfony FormType - довольно похожи. Оба ваши "брокер данных". У каждого своя вещь, но в итоге они похожи. В настоящее время все переходят на од…
22 сен '17 в 22:18
1
ответ
Авторизация Oauth2 в NelmioApiDocBundle
Я пытаюсь использовать NelmioApiDocBundle для документации по API проектов Symfony 3.4, а также пытаюсь обойтись без авторизации OAuth 2 для доступа к API проекта. До сих пор я следовал этому руководству о том, как заставить работать FOSOAuthServerB…
27 мар '18 в 17:17
3
ответа
Установить описание возвращаемого параметра Nelmio ApiDoc
В ApiDoc для нашего контроллера мы указали объект выходного ответа и теперь видим список всех возвращаемых параметров. Как мы предоставляем значения для полей версии и / или описания в этом списке? Я пробовал добавлять @ApiDoc(description="text") к …
27 апр '17 в 21:09
1
ответ
Запрос публикации пакета документов API Nelmio с логическим значением всегда возвращает true
Я разрабатываю приложение Symfony 4 API REST с Nelmio Api Doc Bundle v3. Я отправляю этот запрос: curl -X POST "http://dev.api_events.jessie/api/event-types" -H "accept: application/json" -H "Authorization: Bearer ZmU1MTgxNzNkZjM5ZTU2NzdiODVkODgxMmE…
23 мар '18 в 09:03
2
ответа
NelmioApiDoc - скрыть раздел документации по умолчанию
По умолчанию ApiDoc перечисляет все операции для каждой конечной точки API, например: Однако в демонстрационной версии Swagger операции скрыты по умолчанию, пока пользователь не решит их отобразить. Существует ли параметр конфигурации для ApiDoc, ко…
13 июн '16 в 08:48
1
ответ
NelmioApiDoc v3 / Swagger - несколько документов API
NelmioApiDoc v2 разрешено использовать несколько views параметр, чтобы я мог скрыть некоторые конечные точки и представить их по другому URL https://symfony.com/doc/current/bundles/NelmioApiDocBundle/multiple-api-doc.html Возможно ли сделать это в N…
09 янв '18 в 15:29
1
ответ
Как удалить _format URL-суффикс из документации, созданной NelmioApiDocBundle?
Я установил NelmioApiDocBundle для моего нового API-ориентированного проекта в Symfony, и я не могу избавиться от .{_format} суффикс, который этот пакет добавляет ко всем URL-адресам моей конечной точки. Вот как это выглядит: Мой API не поддерживает…
02 сен '15 в 07:05
1
ответ
Консолидация аннотаций
Можно ли объединить эти две аннотации, чтобы я написал их в одном месте? use Swagger\Annotations as SWG; use FOS\RestBundle\Controller\Annotations\RequestParam; /** * @SWG\Parameter( * name="user_id", * in="query", * type="string", * description="Us…
01 мар '18 в 10:56
2
ответа
Symfony2: почему аннотация представления в NelmioApiDocBundle не работает?
Я хочу разделить мою документацию для API, который я строю. Я использую NelmioApiDocBundle, и у них есть идеальный способ с аннотацией представления. Представление Nelmio Проблема в том, что мой метод остается в представлении по умолчанию, а не в пр…
24 май '17 в 15:03
0
ответов
NelmioApiDocBundle Отправить запрос с телом Json
Я использую Symfony 2.6.1, я использую FosRestApiBundle и хочу документировать его, поэтому я попытался NelmioApiDocBundle, проблема в том, что в почтовых запросах я не могу установить тело почтового запроса, есть ли какое-либо решение этой проблемы…
16 мар '16 в 00:36
1
ответ
Symfony FOSREST API Datetime Ошибка
Я использую Symfony 2.7, я создал API. Когда я отправляю форму (данные json) с помощью почтальона, он не принимает значение datetime. Конструктор форм ->add('letAt','datetime') команда /** * @var DateTime * @Assert\NotNull(message="Please enter l…
21 дек '17 в 06:11
1
ответ
NelmioApiDocBundle Поддержка Swagger 2.0
Я работаю над проектом Symfony 2 с NelmioApiDocBundle v2.13.0, который выводит совместимые с Swagger определения JSON API, основанные на Swagger 1.2, - это старая версия. Я много искал о поддержке NelmioApiDocBundle для Swagger 2.0, но без какого-ли…
05 янв '17 в 10:43
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
1
ответ
Где разместить @SWG\Definition для повторного использования с Swagger-PHP и Nelmio API-DOC Bundle
Я хотел бы написать где-нибудь @SWG\Definition и сослаться на него в аннотации @SWG\Schema в @SWG\Response для нескольких действий REST API в моем приложении Symfony 3. Я использую версию api-doc-bundle от Nelmio, но я могу найти что-нибудь, что под…
27 окт '17 в 16:18
0
ответов
Расширение документа Swagger 2.0 со значениями из базы данных (NelmioApiDocBundle 3.2)
У меня есть запрос API с предопределенными значениями, которые могут быть приняты (статусы). Есть ли способ добавить в документацию Swagger UI список со статусами, полученными из базы данных? Таким образом, когда новый статус добавляется или изменяе…
06 авг '18 в 14:30
1
ответ
Определение модели NelmioApiDoc / как игнорировать геттер или псевдоним существующего свойства с другим именем?
Можем ли мы переопределить имя свойства аксессора модели или проигнорировать его? Вот мой User::getUsername функция, которая является геттером для свойства электронной почты (мне нужна эта функция, названная так, чтобы реализовать интерфейс): class …
17 май '18 в 15:07
2
ответа
Нераспознанная опция "Области" в NelmioApiDocBundle Symfony3.4
Я хочу создать документацию по пользовательскому интерфейсу с swagger для моего Restful API. это официальная документация для этого https://symfony.com/doc/master/bundles/NelmioApiDocBundle/index.html Но я получил эту ошибку Unrecognized option "are…
05 май '18 в 08:24