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

Swagger - это реализация фреймворка для описания, производства, использования и визуализации веб-сервисов RESTful на основе спецификации OpenAPI.
0 ответов

Перевод входных значений HTML в файл спецификации Swagger/OpenAPI

Я знаю, что есть несколько способов конвертировать файл спецификации Swagger в файл HTML, но мне было интересно, есть ли способ сделать это наоборот? Скажем, у вас есть пара полей ввода HTML, например, так: <input type="text" name="title"> &lt…
30 май '18 в 23:25
0 ответов

Настройка Swagger-UI 3.0.X

Swagger-UI недавно обновлен до версии 3.0.X В прошлом папка dist содержала папку lib/css/etc, и я смог успешно скопировать эту файловую структуру для запуска моего веб-приложения. Однако, копируя текущую структуру, я получаю 404 ошибки при попытке п…
28 мар '17 в 00:21
1 ответ

Значение по умолчанию принимается как (пустое) для строки в swagger, хотя я дал значение по умолчанию

Я пытаюсь интегрировать Swagger с моим проектом. Я дал зависимости в pom, скопировал папку dist из swagger в мою рабочую область. <repositories> <repository> <id>oss-jfrog-artifactory</id> <name>oss-jfrog-artifactory-re…
09 фев '15 в 06:25
2 ответа

Как создать swagger.json, используя gradle?

Я хочу использовать swagger-codegen для генерации REST-клиентов и, возможно, статической HTML-документации. Однако для ввода swagger-codegen требуется файл swagger.json. Я знаю, что я могу получить это с работающего сервера REST, оборудованного Swag…
21 сен '16 в 12:07
1 ответ

Использование Swagger с WebApi с версией пространства имен

Я узнал, как создать версию моего WebAPI на основе пространств имен, используя этот класс. Я использую Swashbuckle для добавления документа Swagger в мой API с помощью пакета Swashbuckle Nuget. Если я сохраню все в порядке, при переходе к / swagger …
15 окт '14 в 16:20
0 ответов

Swagger - не поддерживает загрузку нескольких файлов?

Я пытаюсь создать ответ, который вернет 3 файла с одним запросом. Однако, если вы дадите это органу ответа, у меня будут проблемы, потому что я не знаю, можно ли это реализовать. Метод генерации тела ответа, который я собираюсь доставить, пытается в…
23 янв '17 в 09:04
1 ответ

Отдельные URL-адреса пользовательского интерфейса для ASPNETCORE 1.1

У нас есть проект webapi.NET core 1.1. У нас есть два файла контроллера, и я смог сгенерировать отдельные файлы JSON для каждого контроллера, украсив методы с помощью GroupName. Когда я просматриваю пользовательский интерфейс Swagger (/swagger), я в…
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: [email protected] license: nam…
26 сен '18 в 12:11
2 ответа

Изменить список swagger api

Я использую Jersey 2 в качестве реализации JAX-RS для моего REST API. Также я успешно настроил swagger для включения генерации списка API. Я использую статический проект Swagger-UI для отображения страницы с описанием. Мой Maven Pom выглядит так: &l…
04 мар '14 в 18:37
1 ответ

Проблема поддержки полиморфизма в Swashbuckle

Я использую Swashbuckle v3.0. Я не уверен, что это ошибка или нет, но полиморфизм работает не так, как должен. У меня есть следующие классы: BasePersonDocumentDto { Id, Number } IdentityDto: BasePersonDocumentDto { } PassportDto: BasePersonDocumentD…
05 авг '18 в 08:38
0 ответов

Карта объекта в чванстве

Я пытаюсь создать объект карты в Swagger definitions: foo: description: a sample class required: - param properties: param: type: object description: this param is a map<String, Object> where object is a derivative of java.lang.object addition…
12 сен '17 в 10:38
0 ответов

Как десериализовать документ Swagger с помощью $ref с помощью Json.NET?

Мне нужно десериализовать следующий Json: { "swagger": "2.0", "info": { "version": "0.0.0", "title": "Simple API" }, "paths": { "/": { "get": { "parameters": [ { "$ref": "#/parameters/MyParameter" } ], "responses": { "200": { "description": "OK", "s…
22 сен '16 в 23:13
1 ответ

Как установить страницу Swagger в качестве целевой страницы по умолчанию для проекта web api 2?

Я работаю над проектом WEB API 2. Я использую документацию Swagger. Я также использую ODATA V4. Я хочу, чтобы моя страница по умолчанию для веб-API была настроена как swagger. Как я могу это сделать?
0 ответов

Как я могу опубликовать документ Swagger, сгенерированный Springfox как часть процесса сборки

Мы используем Springfox для создания документов Swagger для нашего приложения Springboot во время выполнения. Мы хотели бы опубликовать их где-нибудь как часть нашего проекта Дженкинса. Есть ли способ генерировать эти статические документы как часть…
10 май '18 в 17:25
2 ответа

Параметры заголовка запроса CORS не отправляются в Chrome

Я пытаюсь использовать Swagger UI для остальной документации API. API отдыха создан с помощью сервиса WCF. Я решил проблему cors, сервис принимает метод OPTIONS. Но запрос имеет параметр заголовка с именем SessionUUID, этот параметр не отправляется …
2 ответа

Отображение нескольких методов HTTP для маршрута здоровья весеннего лиса в чванстве

Я использую здоровье привода пружинного башмака с пружинным чванством в проекте пружинного башмака. Я использую ниже в моем классе Application.java. @Autowired private HealthAggregator healthAggregator; @Autowired private Map<String, HealthIndica…
1 ответ

Исключить свойства из списка в Swagger UI

Допустим, у меня есть следующая модель public class UserResourceParameters { public string FirstName { get; set;} public string LastName { get; set; } public string FullName { get => FirstName + " " + LastName; } } И следующее действие контроллер…
4 ответа

Swagger не генерирует swagger.json

У меня есть основной проект MVC asp.net и отдельный проект WebApi в одном решении. Я добавляю чванство в соответствии с документацией на github. Вот мой Startup.cs проекта MVC: public void ConfigureServices(IServiceCollection services) { //... // Ad…
04 сен '18 в 08:46
0 ответов

Существует ли какое-либо соглашение о каталогах для размещения определений Swagger и сгенерированного кода?

У меня есть проект Java, построенный Gradle. Мне интересно, существует ли какое-то уже установленное соглашение о структуре каталогов "по умолчанию" для размещения определений Swagger и, возможно, расположения сгенерированных артефактов? Я искал в G…
21 апр '17 в 09:04
2 ответа

Как установить заголовок ответа при реализации загрузки файла через RestController?

public interface IndexApi { @ApiOperation(value = "Download excel.", response = byte[].class) @ApiResponses(value = { @ApiResponse(code = 200, message = "The excel file", response = byte[].class), @ApiResponse(code = 500, message = "Unexpected error…
02 ноя '17 в 17:21