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

Вопросы с тегом
1 ответ

Swagger 3.0 reDoc Дискриминатор JSON

В настоящее время я пишу документацию по swagger 3.0 и использую reDoc для визуализации для него приятного пользовательского интерфейса. У меня есть несколько сценариев в моей документации, где на основе предыдущего перечисления свойств я хотел бы о…
16 окт '18 в 20:00
1 ответ

Как глобально установить заголовок Accept в Swagger 3.0?

У меня есть новая установка OpenAPI через SwaggerHub. Есть ли возможность принудительно использовать определенный заголовок Accept? Я настроил тип содержимого в ответе. paths: /test-path: get: responses: '200': description: OK content: application/v…
11 янв '19 в 11:43
0 ответов

Несколько кодов ошибок, использующих одну и ту же схему в Swagger UI

У меня есть схема для определенного кода состояния, который я хочу использовать в нескольких ответах. Мы можем иметь несколько сообщений об ошибках для одного и того же кода состояния и могут отличаться в каждом ответе. ErrorCode: type: object prope…
07 фев '19 в 15:47
1 ответ

Получает двойную ошибку ключа сопоставления при использовании openapi 3.0

Я пытаюсь определить свои API, используя openapi версия 3.0.0, Я сгенерировал следующий файл YAML: openapi: 3.0.0 info: title: My YAML description: My YAML version: 1.0.0 servers: - url: http://my.server.url paths: /v1/service/uri: post: summary: Ge…
22 дек '18 в 08:17
0 ответов

Где пример строки ответа генерируется в файлах swagger?

У меня есть вызов API, который я хочу предложить вернуть как читаемый человеком текст (против json), если отправитель устанавливает заголовок Accept в text/plain, Текст возврата будет иметь разрывы строк, поэтому я хочу точно представить шаблон текс…
05 ноя '18 в 20:04
1 ответ

Как вставить незначительные настройки в Swagger внутри его разметки?

У меня есть проект.NET Core, задокументированный Swagger 3 (Swashbuckle.AspNetCore.SwaggerGen 3.0.0 и Swashbuckle.AspNetCore.SwaggerUi 3.0.0). Моя цель - добавить собственный тег прямо под DIV с названием класса (т.е. под названием сервиса, но над к…
12 окт '18 в 08:34
0 ответов

Могут ли быть поля параметров для заголовков содержимого в swagger-ui для конкретного содержимого данных формы в теле многочастного запроса в swagger-3.0?

Я пытаюсь создать документацию для некоторых вызовов REST API. Метод POST в одном из вызовов API принимает содержимое данных формы, состоящее из нескольких частей, с 1-й частью в виде данных двоичного файла и 2-й частью в качестве экземпляра json. Я…
28 янв '19 в 10:55
1 ответ

Сериализация вложенных свойств как данных формы с помощью swagger-php

Вот как делается пример объекта кодирования в OpenApi https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md requestBody: content: multipart/mixed: schema: type: object properties: id: # default is text/plain type: string format:…
29 янв '19 в 07:56
1 ответ

Порядок между AddMvc/AddSwaggerGen и UseMvc/UseSwagger(UI)

Когда я использую свои API с помощью Swagger, я следую одному из этих указаний и всегда ставлю инъекции MVC перед инъекциями Swagger, как это. services.AddMvc(); services.AddSwaggerGen(_ => { ... }); app.UseMvc(); app.UseSwagger(); app.UseSwagger…
25 дек '18 в 20:24
0 ответов

Можно ли определить поле в swagger, которое содержит конкретные значения

Мой API содержит поле result который имеет тип string но он может содержать только одно из следующих значений - success или же error, Как я мог определить это в Swagger? Вместо того чтобы сказать ServerResponse: #{result: ..., additional-info: ...} …
26 ноя '18 в 17:01
0 ответов

Swashbuckle.AspNetCore.Annotations OperationId игнорируется

Я обновил свой код для использования Swashbuckle.AspNetCore (3.0.0). [Swashbuckle.AspNetCore.Annotations, Swashbuckle.AspNetCore.Swagger, Swashbuckle.AspNetCore.SwaggerGen, Swashbuckle.AspNetCore.SwaggerUI all are (3.0.0)] И теперь, когда я использу…
26 окт '18 в 08:01
0 ответов

Невозможно создать простое определение общего ответа API

Мой сервер приложение отправляет json ответ в следующем формате { result: ... //this could be success or error additional-info: ... //this is a wrapper and could contains information depending the the operation } additional-info может быть сообщение…
27 ноя '18 в 19:49
3 ответа

Ни один конструктор для типа SwaggerGenerator не может быть создан с использованием служб из контейнера служб и значений по умолчанию

Я пытаюсь добавить Swagger в свой проект. Полученная ошибка заключается в следующем. Ни один конструктор для типа "Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator" не может быть создан с использованием служб из контейнера служб и значений по умол…
25 дек '18 в 22:30
0 ответов

Фильтровать запрос на получение параметров на основе другого параметра?

У меня есть путь получения с 2 параметрами, который ищет информацию на основе предоставленных критериев. Параметр 1 является логическим значением (параметр 2 - это массив объектов), и когда он установлен в значение true, он должен возвращать данные,…
11 янв '19 в 09:34
0 ответов

Как использовать разные метки для базовой аутентификации учетных данных Swagger 3

Мой API в настоящее время использует базовую аутентификацию с api_xxx вместо username а также api_xxy вместо passwordУ нас есть какая-то конкретная схема для такой ситуации? Все работает точно так же, я хотел бы изменить только метки в пользовательс…
07 фев '19 в 13:56
0 ответов

Невозможно загрузить и запустить сервер Swagger Spring

Я создал определение API на Swagger Editor, Когда я попытался просто запустить Try It Out на UIЯ получил ошибку TypeError: Failed to fetch, Я полагаю, это произошло потому, что у меня не запущен экземпляр сервера. Вот я и подумал скачать сервер из S…
29 ноя '18 в 17:43
2 ответа

Swagger openApi Spec 3.0 - УДАЛИТЬ работу

Я использую Swagger OpenAPI спецификации 3.0 для генерации Swagger из моего интерфейса. У меня есть метод удаления, где он принимает тело запроса. Но согласно RFC7231, DELETE не принимает тело запроса. Также Swagger-тело запроса говорит, что так. Но…
01 мар '19 в 07:13
0 ответов

Доступна ли реализация Springfox для swagger3 или openapi 3?

Существует ли какая-либо реализация springfox для swagger3 или openapi 3, которая поддерживает версионную точку для медиа-типа, кроме JAX-RS?
29 май '19 в 13:58
0 ответов

Ошибка при генерации кода сервера NodeJs в swagger

Пытаясь сгенерировать nodejs Сервер я получаю ниже ошибки. Uncaught (in promise) Error: Internal Server Error at index.js:1 at tryCatch (runtime.js:62) at Generator.invoke [as _invoke] (runtime.js:296) at Generator.e.(/swagger/anonymous function) [a…
22 апр '19 в 07:37
0 ответов

Как добавить поле загрузки файла в Swagger

Я пытаюсь указать файл ввода в чванство. ImportUser: properties: user_type_id: description: ID of the related user type type: integer format: int32 example: '1' nullable: false csv_file: description: CSV file type: **file** skip_first_row: descripti…
15 апр '19 в 09:01