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

Пользовательский интерфейс Swagger для API обмена сообщениями
Я хотел бы знать, возможно ли следующее. Swagger — это почти то, что мне нужно для документирования API на основе сообщений. Например, для Командного сообщения я хотел бы сказать "Команда" вместо "Опубликовать", и вместо «пути» я хотел бы...
1703 просмотров
schedule 09.12.2022

Проверить спецификацию Swagger 2.0 в сборке Maven?
Я следую первоочередному подходу к созданию REST API в стеке Java/Spring MVC. У меня есть написанная от руки схема Swagger, которую я хочу проверить в своей сборке Maven, и я хочу, чтобы эта сборка завершилась ошибкой, если схема не соответствует...
1142 просмотров
schedule 12.05.2024

Ошибка эквивалентного пути Swagger, даже если пути разные [дубликаты]
✖ Swagger Error Equivalent path already exists: /profile/address/{id} ✖ Swagger Error Equivalent path already exists: /profile/qualifications/{id} В редакторе Swagger я получаю эту ошибку. Если вы видите ... пути разные ... даже если он выдает...
743 просмотров
schedule 21.01.2024

Пользовательский интерфейс Swagger — как показать список моделей отдельно
В примере редактора Swagger, http://editor.swagger.io/#/ , есть Раздел «Модели» позже в отображаемом документе после отображения конечных точек. Является ли это только функцией этого редактора, чтобы увидеть, как выглядят вещи, которые вы...
4540 просмотров

Напишите документ swagger, который использует несколько типов контента, например. application/json И application/x-www-form-urlencoded (без дублирования)
Я ищу элегантный способ определить API, который может использовать данные JSON, а также данные формы. Следующий фрагмент работает, но он не элегантен и требует уродливого кода в бэкенде. Есть ли лучший способ определить это? Что сейчас работает:...
3167 просмотров

Пользовательский интерфейс Swagger генерирует неправильную команду Curl
Пользовательский интерфейс Swagger генерирует неправильную команду Curl, как вставлено ниже, и из-за усечения этой строки запроса curl -X GET http://domain:8080/v1/endpoint?access_token=affsfafasfa&type=1 -H "принять: приложение/json" -H "тип...
2007 просмотров
schedule 23.10.2022

Аннотированная документация Swagger для Vert.x
Есть ли еще создатель документации Swagger на основе аннотаций для Vert.x? Все остальные конечные точки управляются с помощью маршрутизаторов, и поэтому, если есть какой-либо способ создать документацию Swagger, это было бы здорово. Я просмотрел...
418 просмотров

Может ли онлайн-редактор swagger принимать URL-адрес YAML в качестве ввода через адресную строку?
Я хочу получить доступ к https://editor.swagger.io/ , но мне нужно, чтобы файл YAML был предварительно загружен на основе в параметре URL. Поэтому, если я хочу просмотреть...
1290 просмотров
schedule 26.02.2024

Почему внешние документы отображаются перед серверами в пользовательском интерфейсе Swagger?
У меня есть следующее определение OpenAPI YAML. Раздел externalDocs находится под разделом servers , но отображается перед сервером в предварительном просмотре в редакторе Swagger ( https://editor.swagger.io/ ). Почему это? openapi: 3.0.0...
217 просмотров
schedule 04.02.2024

Ошибка документации Swagger `Должен быть объектом`
Я вручную пишу чванливую документацию. Но у меня ошибка Should be object Я не знаю, почему я получаю ошибку в приведенном ниже коде. events: $ref: "#/def/Events" Events: type: "object" properties: oneOf: -...
3206 просмотров
schedule 21.11.2022

Как сослаться на ту же схему, что и на свойство?
В моем файле oas.yaml есть следующее: components: schemas: ServiceError: type: object properties: Message: type: string description: "The exception message." ExceptionMessage: type:...
35 просмотров
schedule 15.12.2023

Как создать ссылку общего доступа для редактора Swagger, указывающую на файл .yml с защищенного URL-адреса?
Я использую онлайн-редактор Swagger для документации нашего проекта API. Сам проект размещен в нашем собственном экземпляре Gitlab, защищенном аутентификацией и разрешениями. Пример URL-адреса для аутентифицированных и авторизованных...
65 просмотров
schedule 30.10.2022

Редактор Swagger: сохранить изменения обратно в исходный файл?
Можно ли из редактора Swagger сохранить изменения или правки обратно в исходный импортированный файл? В настоящее время я сохраняю код в виде файла yaml, выполняю сравнение в Intellij, принимаю каждое изменение, а затем сохраняю этот файл. В лучшем...
99 просмотров
schedule 12.12.2023