Вопросы по теме 'swagger-php'

Как правильно аннотировать эту функцию для чванства?
Я пытаюсь написать небольшой Api, используя Slim. Я хочу, чтобы это было хорошо задокументировано, поэтому я установил swagger-php и UI и исследовал его в последние дни. По какой-то причине в моей демо-версии магазина нет всех аннотаций к...
547 просмотров
schedule 05.07.2023

PHP Swagger и Yii
Я искал и обнаружил, что потерялся весь день, и я чувствую, что хожу по кругу. Я написал (с помощью нескольких руководств) простой API для моего приложения на основе Yii. Теперь я пришел, чтобы задокументировать этот API, чтобы другие могли его...
4772 просмотров
schedule 23.11.2023

Модели Swagger-PHP не читаются
В настоящее время мне нужно документировать проект php с использованием swagger. Однако он не следует традиционному шаблону MVC, а вместо этого содержит статические файлы, которые извлекают/принимают данные и что-то возвращают. Ресурсы обычно...
1092 просмотров
schedule 24.04.2024

Два пути для одного и того же метода
Пытался использовать Swagger для создания моей документации для моего PHP Rest API, используя swagger-php. Он работает очень хорошо, не совсем уверен, что я поклонник огромных блоков комментариев из-за документации, но это не проблема. У меня...
4135 просмотров
schedule 23.09.2022

Как указать тело JSON по умолчанию в Swagger-PHP?
Я хочу указать тело JSON по умолчанию для запроса POST в Swagger-PHP. Мои аннотации выглядят так: /** * Setup order * * @SWG\Post( * path="/order/setup", * operationId="setupOrder", * tags={"Orders"}, * summary="Setup...
5413 просмотров
schedule 14.04.2023

Почтовое приложение Swagger OpenAPI / json без requestbody
Мой API использует запросы только с Header - Content-type:application/json объектом. Для того же я использую: @OA\RequestBody( description= "Provide company search parameter", required= true, @OA\JsonContent(...
1489 просмотров
schedule 10.08.2022

Как мне отформатировать OpenApi в swagger-php, чтобы swagger-ui отображал форму вместо массива?
Я использую сборку Laravel и обновляю обозначения для всех своих методов контроллера API с @SWG до @OA. Когда я нажимаю «попробовать» в swagger-ui метода create, я могу заставить его показать (и принять) редактируемый массив параметров и значений...
136 просмотров