Описание тега swashbuckle.examples

0 ответов

Документация C# swagger для отдельных членов объекта body запроса

Мы пишем swagger документацию, используя /// комментарии следующим образом: /// <summary> /// Create a new widget /// </summary> /// <param name="widget"></param> [HttpPost("/create")] [ProducesResponseType(typeof(IPayment), …
2 ответа

Swashbuckle MapType<Type> не работает с параметрами

У меня есть конечная точка API, которая принимает класс ShortGuid в качестве параметра, например: [HttpGet("api/endpoint")] public async Task&lt;IActionResult&gt; GetTablesAsync(ShortGuid id){} Создает чванливое определение: "parameters":[ { "name":…
0 ответов

Swashbuckle не загружает внешний swagger JSON с локального хоста

Согласно документации Swashbuckle.AspNetCore При включении промежуточного программного обеспечения необходимо указать одну или несколько конечных точек Swagger (полностью или относительно текущего хоста) для включения пользовательского интерфейса. У…
0 ответов

Swagger-net (или swashbuckle): как установить пространство имен в запросах xml?

Есть ли способ генерировать примеры запросов с пространствами имен XML с помощью Swagger-Net? Или в автомате? Я думал о чем-то вроде: [SwaggerResponseExample(HttpStatusCode.OK, typeof(ResponseExample), xmlnamespace="wanted xml namespace goes here...…
27 фев '19 в 13:12
1 ответ

Как вернуть Swagger UI HTML в виде строки, используя Swashbuckle

В ASP.NET Core или Classic ASP.NET мы можем использовать Swashbuckle для генерации красивой документации API, включая пользовательский интерфейс для изучения и тестирования операций, непосредственно из ваших маршрутов, контроллеров и моделей. У меня…
16 янв '19 в 16:27
2 ответа

Атрибут SwaggerRequestExample не работает в ASP.NET MVC 5 (.NET Framework 4.5.2)

Я играю с пакетом Swashbuckle.Examples (3.10.0) в проекте ASP.NET MVC. Однако я не могу сделать так, чтобы примеры запросов появлялись в пользовательском интерфейсе. Конфигурация (SwaggerConfig.cs) public static void Register() { var thisAssembly = …
0 ответов

Добавить фильтр авторизации атрибутов в Swashbuckler Реализация Swagger

Нужно добавить AuthorizeFilterAttribute или AnonymousFilterAttribute к конечной точке в реализации Swagger Swashbuckle, чтобы я мог видеть, какой атрибут используется на каждой конечной точке в сгенерированном файле документации в работающем webapi,…
15 фев '19 в 01:19
0 ответов

Операции не определены в спецификации! Swashbuckle.AspNetCore

Возникла ошибка "Нет операций" после переноса моего API-проекта с dotnet core 1.1 на 2.0, а также обновленного Swashbuckle.AspNetCore до последней версии 3.0. База Code имеет контроллеры, которые наследуются от BaseControllers. Код работает нормальн…
1 ответ

Столкновение с проблемой при возврате объекта в ответе Пример в Swashbuckle.Examples

Я использую Swashbuckle.Examples в Web API для лучшей документации. Он отлично работает для примера ответа Swashbuckle, но когда я использую пример примера, когда я запускаю проект, он показывает ошибку. Мой контроллер [SwaggerResponse(HttpStatusCod…
0 ответов

Как работает SwaggerResponseExample в HTTP 400

SwaggerResponseExample HTTP 400 не работает HTTP 200 может отображаться нормально, а HTTP400 нет Но оба способа одинаковы В чем может быть проблема? [SwaggerResponse (HttpStatusCode.OK, "ОК", typeof(ApiRespond))] [SwaggerResponseExample(HttpStatusCo…
23 апр '20 в 05:25
0 ответов

Swashbucke Пример даты, показывающий компонент времени / неправильный формат

Мы указываем свойство ввода с примером значения как такового /// &lt;summary&gt; /// Start date in format YYYY-MM-DD /// &lt;/summary&gt; /// &lt;example&gt;2020-05-31&lt;/example&gt; [DataType(DataType.Date)] public DateTime? From { get; set; } И с…
10 июн '20 в 09:32
0 ответов

Как добавить пример тела POST для чванства с использованием Asp .Net Core

Я использую.Net Core 2.2 и swagger 2.0. Я хочу добавить пример тела как часть документации для операции POST. Я не нашел поддержки для "POST" с телом в Swashbuckle.AspNetCore. Как добавить документацию для тела POST с помощью.Net Core?
0 ответов

swagger with swashbuckle - генерируйте примеры кодирования на разных языках

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

Сортировка части схемы страницы Swagger с помощью Swashbuckle

На моей странице Swagger я (в основном) могу упорядочить операции, как описано на странице Swashbuckle. Под операциями находится раздел "Схемы", показывающий структуры данных, используемые действиями. Эти структуры данных появляются в произвольном п…
29 апр '20 в 20:18
0 ответов

Swashbuckle.AspNetCore с комментариями xml не добавляет пример в файл json

Я перехожу на asp.net core 3.1 и пытаюсь сгенерировать чванство своего API, я также обновился до Swashbuckle.AspNetCore версии 5.4.1. В asp.net core 2 я использовал Swashbuckle.AspNetCore.Examples для добавления примеров к swagger, читая документаци…
1 ответ

Примеры Swashbucket .NET Framework SwaggerRequestExample выдает исключение System.ArgumentNullException

Я использую Swashbucket и Swashbucket.Examples NugetPackages для предоставления Swagger API в.NET Framework (v.4.7.2) Следуя документации на https://github.com/mattfrear/Swashbuckle.AspNetCore.Filters, я пытаюсь использовать атрибут SwaggerRequestEx…
09 июн '20 в 10:28
0 ответов

Как подавить параметр кода в Swashbuckle

У меня есть приложение-функция Azure, в котором Swashbuckle настроен и работает с минимальной конфигурацией. Swashbuckle генерирует веб-страницы с параметрами по желанию, но параметр code добавляется на каждую страницу определений. Как я могу подави…
1 ответ

Azure Pipeline - документ по сборке и генерации

Мой проект - это AspNet Core 2.2 Api, я создаю его в Azure Pipelines (классический). Я хочу сгенерировать документ swagger во время сборки конвейера Azure. Для этого я использую Swashbuckle.AspNetCore.Cli и документы в Retrieve Swagger Directly from…
0 ответов

Описание Swashbuckle не отображается для свойств с определяемыми пользователем типами

Swashbuckle не подбирает описание при генерации Swagger Json для свойств с типами классов. Он отлично работает с примитивными типами данных. например, в приведенном ниже коде оба определения отображаются в файле xml, но только поле с типом stringпоя…
0 ответов

Модель ответа Swagger пуста в C# web api 2.0

Я хочу отобразить ответное сообщение для кода состояния http&gt;= 400 в swagger с помощью swashbuckle. К сожалению, он всегда становится пустым объектом в пользовательском интерфейсе; если я изменю код состояния http 200 в атрибуте "ответ swagger", …