Swashbuckle 5 не может найти мои ApiControllers

Я застрял ... и эти ответы мне не полностью помогли ... хотя и привели меня туда. Просто чтобы сэкономить время другим людям:

Вы должны передать http-конфигурацию из OWIN, а затем зарегистрироваться в ней вместо использования класса GlobalConfiguration следующим образом:

//starup.cs
public void Configuration(IAppBuilder app)
    {
        Config = new HttpConfiguration();
        WebApiConfig.Register(Config);

        app
            .UseResponseLogging()
            .UseRequestLogging()
            .UseHttpErrors()
            .UseExceptionLogging()
            .UseWebApi(Config);

        HandlerConfig.Register(Config);

        SwaggerConfig.Register(Config);
    }

и в файле конфигурации swagger измените метод регистрации на:

public static void Register(HttpConfiguration config)
    {
        var thisAssembly = typeof(SwaggerConfig).Assembly;

        config
            .EnableSwagger(c =>
                {...

Надеюсь это поможет.

Я нашел проблему. После создания пустого тестового проекта я заметил, что WebApiConfiguration регистрируется из запуска приложения global.asax, а не из класса запуска OWIN (как я).

Поскольку Swagger / Swashbuckle подключается к GlobalConfiguration, а также с учетом того, что запуск OWIN и Global.asax живут в разных контекстах (я думаю), исправление состоит в том, чтобы подключить ваш материал WebAPI для регистрации из Global.asax и использовать объект приложения OWIN WebAPI.

Соответствующие биты:

   // global asax
    protected void Application_Start(object sender, EventArgs e)
    {
        GlobalConfiguration.Configure(WebApiConfig.Register);
       // ... more stuff
    }

   //startup.cs
   public void Configuration(IAppBuilder app)
    {
        // This must happen FIRST otherwise CORS will not work.
        app.UseCors(CorsOptions.AllowAll);

        HttpConfiguration config = new HttpConfiguration();

        ConfigureAuth(app);

        // webapi is registered in the global.asax
        app.UseWebApi(config);

    }

После переустановки, как указано выше, теперь я могу видеть контроллеры и действия в пользовательском интерфейсе Swagger.

Я обнаружил, что у меня такая же проблема. Я создал метод расширения, чтобы помочь

using Swashbuckle.Application;
using System.Web.Http;

public static class SwaggerExtensions
{
    public static HttpConfiguration EnableSwagger(this HttpConfiguration httpConfiguration)
    {
        httpConfiguration
            .EnableSwagger(c => c.SingleApiVersion("v1", "A title for your API"))
            .EnableSwaggerUi();
        return httpConfiguration;
    }
}

Затем в моем Startup.cs

public class Startup
{
    public void Configuration(IAppBuilder appBuilder)
    {
        HttpConfiguration httpConfiguration = new HttpConfiguration();

        httpConfiguration
            .EnableSwagger()    // <==== EXTENSION METHOD <==== //
            .MapHttpAttributeRoutes();

        httpConfiguration.Routes.MapHttpRoute(
            "DefaultApi",
            "api/{controller}/{id}",
            new {id = RouteParameter.Optional});

        appBuilder
            .UseWebApi(httpConfiguration);
    }
}

Все эти решения работают для меня, но все они просто неприятные уловки для моей проблемы. После нескольких часов исследования я обнаружил, что проблема в том, что я также использую Glimpse (или другие пакеты, которые меняют таблицу маршрутов).

Вот отличное резюме: https://github.com/domaindrivendev/Swashbuckle/issues/468#issuecomment-139246748

1. Glimpse добавляет прокси замка поверх HttpWebRoute. Итак, HostedHttpRouteCollection - это коллекция RouteProxy, а не HttpWebRoute.
2. В классе APIExplorer есть метод FlattenRoutes, который выполняет цикл foreach через HostedHttpRouteCollection.

3. Реализация GetEnumerator HostedHttpRouteCollection специально ищет HttpWebRoute. См. Код ниже. Поскольку glimpse добавил прокси, перечислитель всегда возвращает 0 маршрутов !!

   public override IEnumerator GetEnumerator()
   {
        // Here we only care about Web API routes.
        return _routeCollection
            .OfType()
            .Select(httpWebRoute => httpWebRoute.HttpRoute)
            .GetEnumerator();
   }

Боюсь, что решения нет, вы можете выбрать то, что хотите использовать: Swashbuckle или Glimpse, но не оба вместе.

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

У меня была такая же проблема, и ничего из этого мне не помогло.

После некоторого возни я понял, что маршруты, которые я пометил как [System.Web.Mvc.Route("visit")], не были обнаружены чванством.

    [HttpGet]
    // ROUTE ATTRIBUTE NOT FOUND BY SWAGGER
    [System.Web.Mvc.Route("visit")]
    public string Visit()
    {

но [System.Web.Http.Route("visit")]

    [HttpGet]
    // ROUTE ATTRIBUTE *IS* FOUND BY SWAGGER
    [System.Web.Http.Route("visit")]
    public string Visit()
    {

Я не уверен на 100%, но если это важно, я тоже перешел с

 public class MyAPIController : Controller

to:

 public class MyAPIController : System.Web.Http.ApiController

Точнее, я удалил оператор using для System.Web.Mvc, но код указан в иллюстративных целях.

Надеюсь, это поможет кому-то еще в будущем :) Удачи!

Swashbuckle находится поверх слоя метаданных WebApi ApiExplorer. Он берет описания операций из ApiExplorer и затем сопоставляет их с описаниями Swagger.

Поскольку ваш контроллер наследуется от BASECONTROLLER, а не от APICONTROLLER, он не будет работать.

Согласно комментарию Джима Уолли

 private IEnumerable<ApiDescription> GetApiDescriptionsFor(string apiVersion)
    {
        return (_options.VersionSupportResolver == null)
            ? _apiExplorer.ApiDescriptions
            : _apiExplorer.ApiDescriptions.Where(apiDesc => _options.VersionSupportResolver(apiDesc, apiVersion));
    }

это метод, с помощью которого Swashbuckle получает все вызовы API. Требуется IApiExplorer. Что, если он не был изменен для чего-то другого, потребуется предоставленный ApiExplorer по умолчанию. Который содержит информацию только о вещах, которые наследуются от ApiController.

Репозиторий Swashbuckle git. просто найдите GetApiDescriptionsFor, и вы сразу перейдете к методу

У меня было множество проблем с интеграцией Owin + Swashbuckle, и ни один из этих ответов не помог мне все исправить. Короче говоря, мне удалось все решить и создать репозиторий с открытым исходным кодом, который будет использоваться в качестве шаблона для всех, кому это нужно.

Проверьте: ASPSwaggerOwinTemplate

Я нашел эту ссылку очень полезной. Это конкретное решение относится к API Microsoft.Azure.Mobile.Server, но оно решило проблему для меня.

Сервер мобильных приложений Azure и Swagger

У меня тоже была эта проблема с использованием OWIN. Проблема была решена путем установки только Swashbuckler Core, как предложено в здесь, и путем редактирования файла Startup.cs как показано ниже:

// Startup.cs
            // ...
            HttpConfiguration config = new HttpConfiguration();
            // ...
            config
                .EnableSwagger(c =>
                {
                    ////add if there's custom root path
                    //c.RootUrl(req =>
                    //    req.RequestUri.GetLeftPart(UriPartial.Authority) +
                    //    req.GetRequestContext().VirtualPathRoot.TrimEnd('/'));

                    c.SingleApiVersion("v1", "A title for your API");
                })
                .EnableSwaggerUi();
            // ...
            appBuilder.UseWebApi(config);

Я был знаком с версией Swashbuckle ядра .NET, которая автоматически расширяла контроллеры. Когда я работал над API фреймворка (неосновным), когда мне наконец удалось что-то показать, я был сбит с толку, потому что не знал, как нажать «Показать / скрыть», и все еще думал, что это не работает.

Вы можете расширить его по умолчанию следующим образом:

.EnableSwaggerUi(c => {
    c.DocExpansion(DocExpansion.List);
});

В моем случае у меня была проблема, аналогичная Alex C. Мне пришлось сделать 2 вещи, чтобы исправить это:

Во-первых, у меня был оператор импорта об использовании MVC, примерно так:

using System.Web.Mvc;

Я удалил этот оператор импорта, и это решило половину проблемы. Еще я заметил, что в одном из контроллеров, которые отображались в Swashbucke, была аннотация, подобная этой

[RoutePrefix("v1/Awesome")]

Где Awesome - имя контроллера AwesomeController. Поэтому я поместил эту аннотацию префикса маршрута прямо перед объявлением моего класса, и теперь он отображается в интерфейсе Swagger.

[RoutePrefix("v1/Amazing")]
public class AmazingController : ApiController

Так что, если у кого-то еще есть эта проблема, вы можете проверить, нужно ли вам добавлять префикс маршрута, как это сделал я.