Как я могу указать URL-адрес в Swashbuckle / Swaggerwork, когда api обслуживается из другого проекта?

Для Swashbuckle 5.x:

Это, по-видимому, установлено с помощью an extensionSwashbuckle. Swashbuckle 5.x указывает на замену этого файла readfag, заменяющий этот файл readfag для миграции, SwaggerDocConfig RootUrl () специально заменяет ResolveBasePathUsing () из 4.x.

Практически это работает так же, как и раньше, похоже, самым большим изменением было то, что он был переименован и перемещен в SwaggerDocConfig:

public void RootUrl(Func<HttpRequestMessage, string> rootUrlResolver)

Пример из readme, измененный для краткости:

string myCustomBasePath = @"http://mycustombasepath.com";

httpConfiguration
    .EnableSwagger(c =>
        {
            c.RootUrl(req => myCustomBasePath);

            // The rest of your additional metadata goes here
        });

Для Swashbuckle 4.x:

Используйте SwaggerSpecConfig ResolveBasePathUsing, и лямбда-выражение считывает вашу известную конечную точку.

ResolveBasePathUsing:

public SwaggerSpecConfig ResolveBasePathUsing(Func<HttpRequestMessage, string> basePathResolver);

Мой API находится за балансировщиком нагрузки, и это было полезным обходным путем для предоставления базового адреса. Вот глупый пример использования ResolveBasePathUsing для разрешения пути с известным базовым путем.

string myCustomBasePath = @"http://mycustombasepath.com";

SwaggerSpecConfig.Customize(c =>
{
    c.ResolveBasePathUsing((req) => myCustomBasePath);
}

Я жестко запрограммировал конечную точку для ясности, но вы можете определить ее где угодно. Вы даже можете использовать объект запроса, чтобы попытаться очистить ваш URI запроса, чтобы он указывал на / web / api вместо / api.

Разработчик прокомментировал этот обходной путь на GitHub в прошлом году:

Лямбда принимает текущий HttpRequest (то есть запрос для данного Swagger ApiDeclaration) и должна возвращать строку, которая будет использоваться в качестве baseUrl для вашего Api. Для приложений с балансировкой нагрузки это должно вернуть путь к балансировщику нагрузки.

Реализация по умолчанию следующая:

(req) => req.RequestUri.GetLeftPart(UriPartial.Authority) +  req.GetConfiguration().VirtualPathRoot.TrimEnd('/');

...

Что касается относительных путей, спецификация Swagger требует абсолютных путей, потому что URL-адрес, по которому обслуживается Swagger, не обязательно должен быть URL-адресом фактического API.

...

Лямбда передается экземпляр HttpRequestMessage ... вы должны иметь возможность использовать это для получения RequestUri и т. Д. Другой вариант, вы можете просто поместить имя хоста в свой web.config, а лямбда просто прочитает его оттуда.