我现在确实需要我的 WebAPI 2 项目的 API 文档,并且我使用了 Swashbuckle 5 NuGet 包。开箱即用,我可以点击 {myrooturl}/swagger 并弹出一个 UI,但其中没有控制器、方法或任何东西。只是我的标题:[基本网址:/EM.Services,api 版本:v1]
我查看了 Swashbuckle 文档,由于我使用的是由 IIS 托管的 OWIN,因此我修改了 SwaggerConfig:
c.RootUrl(req => req.RequestUri.GetLeftPart(UriPartial.Authority) + req.GetRequestContext().VirtualPathRoot.TrimEnd('/'));
我还设置了项目的构建以生成 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 页面上绝对没有控制器。
值得一提的是,我的所有控制器都继承自 BaseController,而 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"));
}
我的具体控制器看起来都是这样的(我尝试将 BaseController 替换为 ApiController 并且没有任何变化):
[RoutePrefix("api/whatever")]
public class FooController : BaseController
而我的 Base 控制器(还)做的不多,只是有一个属性:
[BuildClaims]
public abstract class BaseController : ApiController
使用 IIS Express 或完整的 IIS 时,空白页面仍然存在。
更新:我制作的一个非常基本的人为控制器的示例。它也没有出现,因为我仍然有样板招摇 ui,里面什么都没有。
/// <summary>
/// I am a test
/// </summary>
[RoutePrefix("api/dummy")]
public class DummyController : ApiController
{
[HttpGet]
[Route("foo")]
public int Foo()
{
return 42;
}
}