我当时确实需要WebAPI 2项目的API文档,并且我使用了Swashbuckle 5 NuGet软件包。开箱即用,我可以按{myrooturl}/swagger并弹出一个UI,但是其中没有 Controller ,方法或任何东西。只是我的标题:[基本网址:/EM.Services,api版本:v1]
我看了一下Swashbuckle文档,由于我使用的是IIS托管的OWIN,因此我对SwaggerConfig进行了修改:
c.RootUrl(req => req.RequestUri.GetLeftPart(UriPartial.Authority) + req.GetRequestContext().VirtualPathRoot.TrimEnd('/'));
根据此文档:https://github.com/domaindrivendev/Swashbuckle/blob/1326e753ce9b3a823b3c156b0b601134692ffc58/README.md#transitioning-to-swashbuckle-50
我还设置了项目生成以生成XML文档,并使用以下代码将SwaggerConfig指向该项目:
private static string GetXmlCommentsPath()
{
// tried with an without the \bin
return String.Format(@"{0}\bin\EM.Services.XML", AppDomain.CurrentDomain.BaseDirectory);
}
我不确定XML文档是否工作与它无关,因为我在swagger-ui页面上绝对没有 Controller 。
值得的是,我所有的 Controller 都继承自BaseController,后者又继承自ApiController。
我的WebApiConfig是否有些麻烦?
public static void Register(HttpConfiguration config)
{
config.SuppressDefaultHostAuthentication();
config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));
config.Filters.Add(new ValidateModelAttribute());
config.Filters.Add(new BaseAuthenticationAttribute());
config.MapHttpAttributeRoutes();
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{action}/{id}",
defaults: new { id = RouteParameter.Optional }
);
var jsonFormatter = config.Formatters.OfType<JsonMediaTypeFormatter>().First();
jsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
jsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));
}
我所有的具体 Controller 都看起来像这样(我尝试将ApiController替换为BaseController,并且没有任何变化):
[RoutePrefix("api/whatever")]
public class FooController : BaseController
而且我的Base Controller 还没有做很多事情,只是有一个属性:
[BuildClaims]
public abstract class BaseController : ApiController
在使用IIS Express或完整的IIS时,空白页仍然存在。
更新:
我制作的人为 Controller 的示例确实很基本。它也没有显示,因为我仍然有没有任何内容的样板用户界面。
/// <summary>
/// I am a test
/// </summary>
[RoutePrefix("api/dummy")]
public class DummyController : ApiController
{
[HttpGet]
[Route("foo")]
public int Foo()
{
return 42;
}
}
最佳答案
我被困住了..这些答案并没有完全帮助我...尽管它们使我到了那里。只是为了节省一些时间:
您必须通过OWIN传递http配置,然后在其上注册,而不是像这样使用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配置文件中,将register方法更改为:
public static void Register(HttpConfiguration config)
{
var thisAssembly = typeof(SwaggerConfig).Assembly;
config
.EnableSwagger(c =>
{...
希望这可以帮助。
关于c# - Swashbuckle 5找不到我的ApiControllers,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/31840165/