无法获得swagger xml评论工作(web api 2)

时间:2017-05-14 12:49:51

标签: c# asp.net-web-api swagger

swagger正在运行,但不是xml评论。对SwaggerConfig.cs进行了以下更改:

GlobalConfiguration.Configuration 
    .EnableSwagger(c =>
    {
         c.SingleApiVersion("v1", "Web.API");
         c.IncludeXmlComments(string.Format(@"{0}\bin\SwaggerTesting.XML", System.AppDomain.CurrentDomain.BaseDirectory));
    });

已编辑项目的属性以指向bin文件夹。

在控制器中完成此操作:

  ///<Summary>
    /// Get these comments
    ///</Summary>
    [Route("year/{year:int:length(4)}")]
    [HttpGet]
    [EnableQueryAttribute]  
    public IHttpActionResult GetReviewsByYear(int year)

1 个答案:

答案 0 :(得分:1)

我有类似的问题。奇怪的是,我的Web API项目似乎根本不需要Swagger.config文件,即当我删除它或评论所有行时,Swagger仍然正常工作(当然没有XML注释)。

我已经尝试将它添加到Global.asax.cs或WebApiConfig.cs但无济于事。此外,当我不生成xml doc文件时,根本没有投诉。所以不知何故Swagger.config文件被忽略了。

编辑:问题解决了。 VS 2017运行旧版本而不是新版本时存在一个不同的未知问题。