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

Swashbuckle - это платформа с открытым исходным кодом, которая добавляет Swagger и Swagger-ui в проекты веб-API ASP.NET.
1 ответ

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

У нас есть проект webapi.NET core 1.1. У нас есть два файла контроллера, и я смог сгенерировать отдельные файлы JSON для каждого контроллера, украсив методы с помощью GroupName. Когда я просматриваю пользовательский интерфейс Swagger (/swagger), я в…
1 ответ

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

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

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

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

SwaggerUI не отображает схему модели

У меня есть проект C# Web.API с Swagger и Swashbuckle. У меня есть модель: public class TimeZoneName { public string zoneName { get; } } У меня есть контроллер с методами: public string GetLocalTimeByTimeZone(TimeZoneName timezone) { //Stuff Happens…
0 ответов

Swashbuckle - дублированные маршруты, странное поведение

У меня есть WebApi, где мне нужны мультитенантные версии маршрутов. Это легко сделать с помощью префикса маршрута. Оба маршрута v1 и v2 имеют контроллеры A,B,C, а контроллер C в v2 имеет различную реализацию. Эта конструкция предназначена для того, …
15 дек '16 в 23:31
0 ответов

Swashbuckle все еще не показывает контроллеры OData с Swashbuckle.OData

Я установил Swashbuckle v5.3.2, Swashbuckle.OData v2.18.3, но документы Swagger по-прежнему не будут отображать мои контроллеры OData. Мои контроллеры API выглядят просто отлично. Что я делаю неправильно? Это мой класс контроллера: [LogActionFilter,…
1 ответ

Swashbuckle aspnet core 2.0 Swaggerconfig.cs не создан

Я пытаюсь установить Swashbuckle к моему веб-API в aspnet core 2.0, Читая повсюду в Google о том, как его настроить, написано о SwaggerConfig.cs в папке App_Start. Но когда я устанавливаю это никогда не создается?? Где это находится? Все, что я могу…
27 апр '18 в 13:28
1 ответ

Swagger - модифицированная тема не загружается

Я попытался использовать модовый интерфейс Swagger отсюда https://github.com/jensoleg/swagger-ui Я скачал и использовал dist папка, но пользовательский интерфейс не загружается вообще. Я использую Swashbuckle в своем проекте Web API, и он просто заг…
1 ответ

OAuth Swashbuckle завершается ошибкой, когда ответ возвращается в o2c-html

Мой супер простой пример приложения Web API успешно рендерит документ swagger/ui. Но он не работает, если я пытаюсь настроить его для выполнения авторизованных вызовов OAuth 2.0. Если вы нажмете значок, чтобы отобразить запрос согласия OAuth, а зате…
19 июн '17 в 21:20
0 ответов

Как создать документацию о свойствах класса из источников, отличных от XML-комментариев, с помощью Swagger в ядре.net?

Я использую Swashbuckle и swagger для документирования классов моделей в моем приложении. Мои свойства класса в настоящее время задокументированы с использованием комментариев XML: options.IncludeXmlComments(xmlCommentPath); Это достаточно просто. М…
24 ноя '18 в 23:49
1 ответ

Какова цель параметра EnableSwagger routeTemplate?

Я пытаюсь решить проблему, когда мои контроллеры украшены RoutePrefix следующим образом: [RoutePrefix("api/v{version:apiVersion}/users")] Но Swagger отображает URL в оглавлении следующим образом: /api/v{version}/users/search Я экспериментировал с па…
29 июн '18 в 16:48
1 ответ

Ошибка получения FABRIC_E_TIMEOUT для SwaggerUI/swagger.json

Я занимаюсь разработкой Azure Service Fabric Service, в которой я использовал Swashbuckle.AspNetCore для создания Списка API. Я использую следующий код в моем файле Startup.cs В ConfigureServices(службы IServiceCollection) services.AddSwaggerGen(c =…
3 ответа

Как добавить описание метода в Swagger UI в приложении WebAPI

Я использую Swagger в качестве своего инструментария API, и пока он работает отлично. Я только что наткнулся на эту страницу https://petstore.swagger.io/ и увидел, как у каждого метода есть описание. Например, POST: pet/ описывается add a new Pet to…
1 ответ

Общие коды ответов Swashbuckle

Есть ли способ определить "общие" коды ответов, которые применимы для всех вызовов. Например, все вызовы могут возвращать одно из следующего: 400 - Bad request 500 - Internal server error (unknown exception occurred) 503 - Service unavailable (maint…
12 июл '18 в 18:20
2 ответа

Добавление информации о модели к выводу чванства

Есть ли способ добавить информацию о модели, например, действительные значения, значения по умолчанию, сводку и другие замечания в вывод сваггера? Например, в C#, как бы я добавил следующие комментарии и атрибуты в Swagger? /// <summary> /// A…
12 май '16 в 19:00
1 ответ

Добавьте Swagger UI в пользовательский.NET Web API

Я хочу интегрировать Swagger UI в мой проект C# .Net Web API. Это отличается от традиционного проекта Web API, где вы можете установить инструмент, такой как SwashBuckle, который затем выбирает маршруты HTTP, определенные в ваших классах контроллера…
0 ответов

Показывать длительность HTTP-запроса в Swagger UI

Swagger UI имеет параметр displayRequestDuration, чтобы показать, сколько времени занимает запрос. Это отключено по умолчанию. Как это можно включить в конфигурации SwaggerConfig.cs при использовании Swashbuckle (неосновная версия)? Я вижу, что это …
24 янв '19 в 16:30
1 ответ

Обновление до Swashbuckle.AspNetCore 3.0 больше не группирует по тегам

Я использовал [SwaggerOperation(Tags = new[] { "GroupA" })] сгруппировать мои действия в контроллере в Swagger UI. После обновления до 3.0 это больше не учитывается и группируется только по имени контроллера. "Измененные" имена тегов из атрибута так…
0 ответов

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

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

Лучшая практика для использования схем JSON v4 в Swashbuckle

У меня есть отличные схемы json v4.0 с проверочными выражениями и примерами. Я пытался поменять их как внешние $refs, но это не получилось хорошим вариантом со схемами Swashbuckle и json v4, так как эти $ refs также не проверяются с помощью валидато…
29 май '18 в 22:27