Articles of swagger

swagger-php имеет разные документы из одного и того же кода

Мы используем slim framework и swagger–php для динамического создания документации swagger. Теперь у нас есть некоторые специальные методы в API, которые не должны публично оформляться. (/ doc now) Есть ли способ получить второй URL-адрес документации (/ doc2), где я могу получить секретные методы и параметры документально? (без необходимости делать документацию вручную, просто используя аннотации в […]

Как правильно добавить параметр без ошибок в доктрине swagger zircote

Я использую swagger в первый раз, а приведенный ниже код приводит к ошибке «Недействительный параметр». /** * @SWG\Post( * path="/pub/user/login", * summary="Login", * tags={"User"}, * @SWG\Parameter( * name="phone", * in="formData", * description="The phone from the database", * required=true, * type="string" * ), * @SWG\Parameter( * name="token", * in="formData", * description="The token for this device and […]

Symfony NelmioApiDocBundle swagger-ui PHP Аннотации объекта json с массивом свойств объектов, не показывающих

Я пытаюсь опубликовать json с NelmioApiDocBundle, у меня есть пример json, который появляется, но свойства объекта массива не отображаются в примере try? Я пробовал несколько методов для достижения этого без успеха. Ниже приведен код, который я пробовал. Любая помощь очень ценится. когда я пытаюсь добавить пример для элементов, он ставит кавычки вокруг массива, поэтому его […]

Могу ли я использовать шаблон тестирования swagger с приложением non nodejs?

Я работаю над созданием набора тестов api для приложения php. Сейчас приложение использует аннотацию swagger, и я могу легко создать swagger.json. Но, глядя на шаблон теста swagger, похоже, что я должен сначала создать приложение nodejs, используя узел swagger? Есть ли способ пропустить этот шаг и вместо этого использовать приложение php? Редактирование: у меня уже есть […]

Как использовать ссылки на примеры Swagger?

Спецификация JSON: "responses": { "200": { "description": "Успешный ответ сервиса", "schema": { "$ref": "#/definitions/BaseResponse" }, "examples": { "application/json": { "status": true, "response": { "$ref": "#/definitions/Product" }, "errors": null } } } } Результат: Но мне нужно: { "status": true, "response": { "ProductNumber": "number", "Barcode": "number", "Length": 12, "Width": 34, "Height": 423, "Volume": 1232 } }, […]

Могу ли я использовать массивы использования swagger-php в строке запроса?

Я использую Swagger-php. Когда я определяю параметр, который находится в строке запроса, он может быть массивом. Но из того, что я вижу, он не поддерживает такой запрос: https://api.domain.tld/v1/objects?q[]=1&q[]=5&q[]=12 Я считаю, что это было бы установлено в поле collectionFormat если это возможно. В настоящее время я только что использовал pipes , но я хочу использовать вышеуказанный […]

Swagger-PHP для создания JSON-файла для Swagger-UI

Я пытаюсь использовать Swagger-PHP для генерации файлов JSON, поэтому я могу использовать его с Swagger-UI для автоматической документации. Я попробовал ссылку: https://github.com/zircote/swagger–php Также я попытался работать с документацией по адресу http://zircote.com/swagger-php/installation.html Но моя неудача, я не могу ее реализовать. Я могу правильно установить композитор. Также установлен пакет Swagger-PHP. Но проблема в том, что я не […]