gpt4 book ai didi

c# - Swashbuckle 5 找不到我的 ApiControllers

转载 作者:IT王子 更新时间:2023-10-29 04:23:32 36 4
gpt4 key购买 nike

我确实需要 WebAPI 2 项目的 API 文档,我使用了 Swashbuckle 5 NuGet 包。开箱即用,我可以点击 {myrooturl}/swagger 并弹出一个 UI,但其中没有 Controller 、方法或任何东西。只是我的标题:[ base url:/EM.Services , api version: 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 。

就其值(value)而言,我的所有 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 看起来都是这样的(我已经尝试用 BaseController 代替 ApiController,但没有任何变化):

[RoutePrefix("api/whatever")]
public class FooController : BaseController

我的 Base Controller (目前)还没有做太多事情,只有一个属性:

[BuildClaims]
public abstract class BaseController : ApiController

使用 IIS Express 或完整的 IIS 时,空白页面仍然存在。

更新:我制作的一个非常基本的人为 Controller 示例。它也没有显示,因为我仍然有样板招摇的 ui,里面什么也没有。

/// <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配置文件中,将注册方法更改为:

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/

36 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com