Описание тега swagger-editor

Редактор Swagger позволяет пользователям создавать спецификации API с помощью YAML внутри браузера и просматривать документацию в режиме реального времени.
3 ответа

Как настроить сообщение об ошибке в сваггере, когда значения обязательных полей не отправляются в API?

Ниже мой api.yml: openapi: 3.0.0 info: title: 'AutoDelievery API' description: 'AutoDelievery API Documentation' termsOfService: 'https://www.yopmail.com' contact: name: yopmail url: 'http://www.yopmail.com' email: contactus@yopmail.com license: nam…
26 сен '18 в 12:11
0 ответов

Как использовать "Авторизироваться" в онлайн-редакторе Swagger?

Я пытаюсь использовать чванство онлайн-редактор http://editor.swagger.io/ Есть кнопка "Авторизовать", которая открывает диалог, в котором вы можете указать способ авторизации. Есть два варианта Первый предназначен для OAuth2, а второй - для API-ключ…
08 июл '17 в 20:58
1 ответ

Swagger в Джерси Swagger Core 1.X

Я использую Swagger с Jersey 1. Он генерирует спецификацию в спецификации Swagger v1.2. Большинство инструментов (например, редактор) требуют спецификации v2.0. Есть ли способ генерировать spec v2.0? Я на самом деле хотел печатные / статические доку…
21 май '15 в 17:59
1 ответ

Редактор Swagger выдает ошибку при указании ответа "Недопустимое определение ответа"

Я пытаюсь сгенерировать документацию по API с помощью редактора Swagger. Я указал свою спецификацию API следующим образом paths: /opendata/v1/{index}: get: tags: [verification] description: Verify the person information parameters: - name: index in:…
05 дек '17 в 12:16
1 ответ

Swagger YAML Query (тип объекта) Ошибка определения параметра

Я получаю следующую ошибку: Ошибка схемы в paths./cards/count.get.parameters[0] не совсем одна из <# / Definitions / Параметр>,<# / Definitions / jsonReference> Вот мое определение: /cards/count: get: tags: - "cards" summary: "Number of Cards availa…
0 ответов

Как определить соединение с базой данных в Swagger

Я сделал много исследований и разработок на чванство. Я хочу построить API в Swagger и хочу определить строку подключения к базе данных внутри Swagger, но до сих пор я не нашел ни одного инструмента в Swagger, который может это сделать. Я просто хоч…
0 ответов

Редактор Swagger: Невозможно установить тип содержимого в многочастном запросе

Я использую онлайн редактор Swagger с OpenAPI 3.0, и мне нужно создать определение загрузки файла. Проблема в CURL, который генерирует редактор. В случае, когда расширение файла "неизвестно" (например,.abc), редактор не генерирует тип curl -X POST "…
26 июл '18 в 17:27
1 ответ

Swagger UI - невозможно включить редактор JSON для тела запроса

У меня есть некоторые проблемы, чтобы заставить его работать, согласно следующей ссылке ниже, JSON-редактор для тела запроса (по умолчанию отключен). https://github.com/jensoleg/swagger-ui Как я могу включить это? Я использую локальную машину. Пожал…
0 ответов

Swagger не отображает свойства объекта в пользовательском интерфейсе

Я делаю документацию для API.На данный момент у меня есть: /script/update: post: tags: - "Script" summary: Update a script operationId: updateScript responses: '200': description: OK "404": description: Not Found requestBody: description: A script o…
18 сен '18 в 11:06
2 ответа

Недопустимое определение параметра, Swagger 2.0

Я новичок в Swagger и следующий код, который я пытался редактировать в онлайн-редакторе. Но в поле параметров отображается ошибка "Недопустимое определение параметра". # Example YAML to get you started quickly. # Be aware that YAML has indentation b…
15 сен '16 в 06:58
1 ответ

Ссылка на параметры в определении одной и той же причины файла вызывает ошибку Swagger

Я пытаюсь сослаться на некоторые параметры, которые я использую по нескольким путям, в разделе определения файла swamger yaml, и хотя документация отображается так, как ожидалось, и запросы создаются правильно при использовании try it out Кнопка, я …
24 ноя '15 в 13:40
1 ответ

При создании документации REST API с использованием Swagger 2.0 получаю эту ошибку

Почему я получаю сообщение об ошибке "Операция не может иметь несколько параметров тела" в редакторе Swagger?
16 янв '17 в 16:56
0 ответов

Проблема проверки Swagger - Неправильное определение параметра -

Я борюсь с проблемой с Swagger и собираюсь сходить с ума... Это в основном работает, за исключением одного параметра. Вот ситуация: Мой API может принимать некоторые ограничения поиска в URL. Пользователи могут иметь более одного поискового ограниче…
01 май '17 в 13:36
0 ответов

Можно ли указать массив ответов API (используемый в качестве упорядоченной пары) в Swagger?

У меня есть необходимость документировать API через Swagger. Ответ API имеет 2 элемента массива, как это: [[RFC3339 метка времени, значение float64], ...] Я не уверен, как определить упорядоченную пару (для которой мы используем массив из 2 элементо…
30 май '17 в 14:32
1 ответ

Режим мошенничества Swagger генерирует некоторые случайные данные, а не возвращает тот, который я определил в своем контроле

В последнее время чванство начинает вести себя очень странно. Это не возвращает данные актового макета, которые я определил в своем контроллере. в основном это не вызов фиктивного контроллера вообще. Для всех API это перезапуск некоторого системного…
04 май '16 в 09:40
1 ответ

Написать документ swagger, который использует несколько типов контента, например application/json AND application/x-www-form-urlencoded (без дублирования)

Я ищу элегантный способ определения API, который может использовать данные JSON, а также данные формы. Следующий фрагмент кода работает, но он не элегантен и требует всего вида уродливого кода в бэкэнде. Есть ли лучший способ определить это? Что раб…
17 фев '17 в 00:30
0 ответов

Как создать отфильтрованный Swagger JSON на основе тегов

У нас есть несколько контроллеров REST (построенных на ASP.NET Core), содержащих десятки конечных точек. Мы логически сгруппировали эти конечные точки, используя теги Swagger, например: [SwaggerOperation(Tags = new[] { "FromLandingPage"})] public as…
04 сен '18 в 06:19
1 ответ

Swagger UI - чтение спецификаций JSON из редактора в UI без хостинга

Я пытаюсь документировать свой API с помощью Swagger, написав документацию в редакторе Swagger и затем загружая его в интерфейс Swagger. Я использовал редактор и загрузил свой файл JSON, а затем изменил файл /dist/index.html в интерфейсе пользовател…
06 авг '15 в 15:26
1 ответ

SwaggerUI/YAML - ошибка синтаксического анализатора, неверный отступ записи сопоставления

Снимок экрана: редактор Swagger и код Здравствуйте, я новичок в тестировании API и Swagger и получаю это сообщение об ошибке синтаксического анализатора в редакторе Swagger, и у меня возникают проблемы с обнаружением проблемы. Сильфон является копи…
13 сен '18 в 13:14
1 ответ

Проверка HTTP ответа в чванстве

Можно ли проверить HTTP-ответ в редакторе Swagger и / или в интерфейсе Swagger? Мне нужно проверить, что конкретный ответ имеет именно ту структуру и данные, которые я хочу. Например, тело должно быть {"message":"pong"}.
04 июл '17 в 08:56