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

Swagger 2 принимает xml вместо json
У меня есть проект с весенней загрузкой, и я хочу использовать swagger2 для документирования своих веб-сервисов json. У меня есть эта конфигурация: @Configuration @EnableSwagger2 public class Swagger2Config { @Bean public Docket...
2848 просмотров
schedule 07.05.2023

Несколько примеров тела в чванстве
У меня есть метод, который принимает объект. Объект является динамическим и может быть сконструирован 5 различными способами в зависимости от количества дочерних элементов и типа объекта. Я хочу, чтобы было ясно, как построить этот объект, а также...
1675 просмотров
schedule 16.02.2023

$ref не работает при использовании нескольких вложенных файлов при создании документации swagger.
Я не уверен, что я ошибся здесь, но последние несколько дней я возился со Swagger и пытался настроить свою документацию таким образом, чтобы я мог разделить документацию на более мелкие и более управляемые файлы. Однако я обнаружил, что когда я...
456 просмотров
schedule 28.06.2023

Заголовок ответа местоположения, возвращенный из веб-API в Swagger-ui
Я возвращаю Uri в качестве заголовка местоположения ответа от моего контроллера web-api, как показано ниже: [HttpPost] public HttpResponseMessage PostTenant([FromBody] JObject value) { string tenantName; try { tenantName =...
3704 просмотров

Свойство Swagger требует ложной причины ошибки
Я пытаюсь определить API с помощью Swagger 2.0. В моей модели у меня есть объект с необязательными атрибутами, поэтому я пытаюсь вставить тег Swagger «required: false». Когда я вставляю тег «обязательный», я получаю сообщение об ошибке в...
5063 просмотров
schedule 24.11.2023

Документ Swagger/Swashbuckle POST с JSON
У меня проблема с Swashbuckle или Swagger. Я не уверен, что проблема в Swagger или Swashbuckle. У меня есть вызов веб-апи, реализованный как с параметром в виде параметров URI, так и с чтением содержимого из тела запроса. Один реализован так:...
1679 просмотров

Открыть API POST с параметром пути
Я пытаюсь написать спецификацию Open API с помощью Swagger-ui (swagger версии 2.0), и я не уверен, как представить параметр POST с параметром path POST /ping/{text} Моя спецификация выглядит следующим образом, # this is an example of...
4205 просмотров

Swagger 2 / Springfox для Spring MVC
Я настроил в своем приложении Spring MVC Swagger 2 / Springfox . К сожалению, я не вижу описания документации Javadoc. Кто-нибудь уже успешно использовал его? Кто-нибудь может подсказать? Я знаю Swagger 1. Он берет документацию, параметры... из...
409 просмотров
schedule 21.07.2023

Поддерживает ли Swagger 2.0 нечистый дизайн REST API?
Текущая спецификация Swagger утверждает, что Swagger используется для описания и документирования RESTful API . Я думаю, что это не так, скорее я думаю, что Swagger полезен для простого описания HTTP API по нескольким причинам: В спецификации...
962 просмотров
schedule 16.11.2023

Есть ли способ определить один и тот же путь несколько раз с изменением параметров?
Мне нужно определить службу, которая используется несколько раз с изменением параметров. Мне нужно определить это несколько раз, но всякий раз, когда я определяю ее во второй раз, она автоматически перезаписывает предыдущую. Вот как я это определил....
3726 просмотров
schedule 16.02.2023

Недопустимое определение параметра Swagger.json
У меня есть это определение чванства /memberdetails/Prospect: post: tags: - memberdetails summary: Create member details using member object. operationId: memberdetails.Prospect parameters: - name:...
2471 просмотров

Пользовательский интерфейс Swagger не отображает значения перечисления в моделях
У меня возникла небольшая проблема с использованием пользовательского интерфейса Swagger, и я еще не уверен, является ли это ошибкой или нет... Я описал свой API с помощью редактора Swagger, и у меня есть метод, содержащий параметр enum. Теперь...
1773 просмотров
schedule 07.12.2022

swagger-codegen пропускает недопустимый тип свойства: массив
При запуске java -jar swagger-codegen-cli.jar generate -i ../tech-bucket/membership-card/apis/mini.swagger -l nodejs-server в соответствии со спецификацией swagger ниже я вижу две ошибки/предупреждения: [main] ERROR...
530 просмотров
schedule 10.04.2023

Как повторно использовать строковый блок в Swagger
Я пишу файл swagger для AWS API Gateway. Мне нужно использовать блок текста для интеграции для каждой конечной точки. Так сейчас выглядит одна конечная точка '/products/{productId}': get: tags: - product summary: Get detailed...
650 просмотров

Массив объектов как входной параметр в swagger
Я пытаюсь описать следующий параметр сообщения в чванстве: { "sources": [ { "id": 101, "parentId": 201 },{ "id": 102, "parentId": 201 },{ "id": 102,...
22946 просмотров
schedule 17.06.2023

swagger path $ref для запросов OPTIONS
Я хочу создать развертывание шлюза API из файла swagger.yml. Мне нужно поддерживать CORS для всех конечных точек. Все мои определения пути options абсолютно одинаковы. Как определить путь options в одном месте и $ref там, где я хочу его...
884 просмотров
schedule 14.03.2023

Java 8 LocalDate отображается в чванстве
У меня есть DTO, который содержит поле типа Java 8 LocalDate. С аннотациями Джексона можно установить формат ISO.DATE , и все работает хорошо. Но Swagger (у меня версия 2.+) видит LocalDate.class как объект LocalDate { month (integer,...
9019 просмотров

Использование различных свойств моделей Swagger для сбора / подробного запроса / ответа
Я новичок в Swagger и пытаюсь определить конечные точки, у которых есть: Некоторые свойства только для чтения, которые не разрешены в запросе, но отображаются в ответе Некоторые свойства только для белого и скрытые, которые разрешены в запросе,...
764 просмотров
schedule 28.05.2022

Swagger 2: использовать ссылку enum в параметре запроса типа массива
Не могу понять, как использовать ссылку строкового типа со значениями перечисления в параметре массива. Я могу сделать ссылку в ключе items, и он работает, но Swagger выдает ошибку: недопустимое определение параметра Веб-интерфейс генерирует...
7265 просмотров
schedule 10.01.2023

Массив Swagger целочисленного возвращаемого типа
Я только начинаю использовать редактор swagger для определения моего RESTful API, и я запутался в ответах. Многие из моих методов просто возвращают массив целых чисел, и я не понимаю, как указать это в YAML.
14834 просмотров
schedule 19.04.2024