swagger UI 在 webapi 中没有显示任何内容

Question

我按照 this 直到 xml 文档部分，以便使用 Swashbuckle 创建 Swagger 文档。它应该允许我通过（在我的例子中）查看端点：

http://localhost:51854/swagger/ui/index

不幸的是，我看不到任何端点：

任何想法为什么以及如何解决这个问题？请注意，我是从一个空的 webapi 项目创建我的 webapi - 也许这就是问题所在。肯定少了什么，但我不确定是什么......

我现在已经确定以下代码是根本原因。在 Global.asax.cs 中：

var container = new XyzWebApiStructureMapContainerConfigurator().Configure(GlobalConfiguration.Configuration);
GlobalConfiguration.Configuration.Services
.Replace(typeof(IHttpControllerActivator),
new StructureMapHttpControllerActivator(container));

部分课程：

public class XyzWebApiStructureMapContainerConfigurator
{
    public IContainer Configure(HttpConfiguration config)
    {
        var container = new Container(new BlaWebApiRegistry());
        config.DependencyResolver = new StructureMapDependencyResolver(container);
        return container;
    }
}

public class StructureMapDependencyResolver : StructureMapDependencyScope, IDependencyResolver, IHttpControllerActivator
{
    private readonly IContainer _container;

    public StructureMapDependencyResolver(IContainer container)
        : base(container)
    {
        _container = container;
        container.Inject<IHttpControllerActivator>(this);
    }

    public IDependencyScope BeginScope()
    {
        return new StructureMapDependencyScope(_container.GetNestedContainer());
    }

    public IHttpController Create(
        HttpRequestMessage request,
        HttpControllerDescriptor controllerDescriptor,
        Type controllerType)
    {
        var scope = request.GetDependencyScope();
        return scope.GetService(controllerType) as IHttpController;
    }
}

附：

简化的控制器代码：

[RoutePrefix("api/XYZ")]
public class BlaController : ApiController
{
    private readonly ISomething _something;

    public BlaController(ISomething something)
    {
        _something = something;
    }

    [Route("")]
    [HttpGet]
    public IHttpActionResult Resources([FromUri] BlaRequest blaRequest)
    {
        // something exciting
        return Ok(returnObject);
    }
}

附言：

更多代码：

// WebApi配置

public static void Register(HttpConfiguration config)
{
    // Web API configuration and services  

    // Web API routes
    config.MapHttpAttributeRoutes();

    //var cors = new EnableCorsAttribute("*", "*", "*");
    config.EnableCors();

    config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
    );
}

// 全局.asax.cs

public class WebApiApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        GlobalConfiguration.Configure(WebApiConfig.Register);

        GlobalConfiguration.Configuration.Formatters.Clear();
        GlobalConfiguration.Configuration.Formatters.Add(new JsonMediaTypeFormatter());

        var container = new XyzWebApiStructureMapContainerConfigurator().Configure(GlobalConfiguration.Configuration);
        GlobalConfiguration.Configuration.Services
        .Replace(typeof(IHttpControllerActivator),
            new StructureMapHttpControllerActivator(container));
    }
}

PPPS：

{
swagger: "2.0",
info: {
version: "v1",
title: "Bla.Di.Bla"
},
host: "localhost:51854",
schemes: [
"http"
],
paths: { },
definitions: { }
}

Answer 1

原来这一行：

config.DependencyResolver = new StructureMapDependencyResolver(container);

在问题的类 XyzWebApiStructureMapContainerConfigurator 中导致了一些问题。

希望这对将来的人有帮助。

Answer 2

有同样的问题。事实证明，DI（在我的例子中是 Unity）被配置为绑定所有加载的程序集（其中一个是 Swashbuckle.Core）。

只要稍微改进一下绑定哪些程序集就解决了这个问题：

var assemblies = AppDomain.CurrentDomain.GetAssemblies().Where(asm => asm.FullName.StartsWith("MySolution.MyProject"));

// Web API configuration and services
var container = new UnityContainer();
container.RegisterTypes(
    AllClasses.FromAssemblies(assemblies),
    WithMappings.FromMatchingInterface,
    WithName.Default);

config.DependencyResolver = new UnityDependencyResolver(container);

Answer 3

我在招摇时遇到了同样的问题，花了很长时间来寻找解决方案。终于拿到了 将 [HttpGet] 或 [HttpPost] 属性添加到每个控制器的操作方法。

[HttpPost]
public IActionResult TestMethod()
 {
  //// Some code
 }

Answer 4

在我的案例中，问题是由 IIS Express 虚拟目录引起的，这里是详细的解释：

我有一个 API 项目，这是项目属性的样子：

这些属性被写入 applicationhost.config 文件，位于：

MySolutionPath\.vs\MySolution\config

这是存储虚拟目录信息的文件部分：

<sites>
  <site name="MyProject" id="3">
    <application path="/" applicationPool="Clr4IntegratedAppPool">
      <virtualDirectory path="/" physicalPath="C:\MyProjectPath\MyProject" />
    </application>
    <bindings>
      <binding protocol="https" bindingInformation="*:44334:localhost" />
      <binding protocol="http" bindingInformation="*:53242:localhost" />
    </bindings>
  </site>
  ..
</sites>

一切正常...

然后我开始关注 this 指南，它要求我将项目 URL 更改为：

https://localhost:44334/Swagger

我这样做然后点击Create Virtual Directory按钮。

这样做对applicationhost.config文件进行了以下更改：

<sites>
  <site name="MyProject" id="3">
    <application path="/" applicationPool="Clr4IntegratedAppPool">
      <virtualDirectory path="/" physicalPath="C:\MyProjectPath\MyProject" />
    </application>
    <application path="/Swagger" applicationPool="Clr4IntegratedAppPool">
      <virtualDirectory path="/" physicalPath="C:\Shopless\shopless.source\Shopless.Api" />
    </application>
    <bindings>
      <binding protocol="https" bindingInformation="*:44334:localhost" />
      <binding protocol="http" bindingInformation="*:53242:localhost" />
    </bindings>
  </site>
  ..
</sites>

这就是问题所在，因为现在路径 /Swagger 指向我项目的根目录。

为了解决这个问题，我不得不从 applicationhost.config 文件中删除新的部分，并将项目 Url 更改回它的原始值。

Answer 5

我意识到这是一个老问题，但我刚刚遇到它并且对已经提出的问题有不同的解决方案。我希望它对其他遇到问题的人有用。

这个问题是由结构图扫描引起的。我的 Structuremap.Registry 类中有以下代码行

Scan(scan =>
{
    ....
    scan.AssembliesFromApplicationBaseDirectory();
    scan.TheCallingAssembly();
    scan.WithDefaultConventions();
});

线

scan.AssembliesFromApplicationBaseDirectory();

正在停止 Swagger 的工作。我改成了

scan.AssembliesFromApplicationBaseDirectory(MyDllsPathFilter());

现在 Swagger 正在按预期工作。

Answer 6

您需要抑制内容安全策略的自定义标头。这些标头阻止 swagger js 的执行。

删除标题之前

评论内容-安全-政策

删除标头后带有端点的 Swagger UI