小编use*_*723的帖子

如何在Swagger中显示类属性的XML注释(MVC 6 Web API JsonResult)

我已经向我的班级成员添加了XML注释,但Swagger不会在UI中显示它们.难道我做错了什么?

更新:看起来您无法使用@ApiModel和@ApiModelProperty注释在Swashbuckle(5.5.3)中记录您的模型类,并且xml注释也不起作用.

public class DataController : ApiController
{
    [Route("api/GetData")]
    [SwaggerResponse(HttpStatusCode.OK, Type = typeof(MyData))]
    public System.Web.Mvc.JsonResult GetData()
    {
        MyData myData = new MyData();

        return new System.Web.Mvc.JsonResult
        {
            Data = myData
        };
    }
}

public class MyData
{
    /// <summary>
    /// My code
    /// </summary>
    public string code;

    /// <summary>
    /// My name
    /// </summary>
    public string name;
}
Run Code Online (Sandbox Code Playgroud)

在此输入图像描述

Swagger配置

public class SwaggerConfig
{
    public static void Register()
    {
        var thisAssembly = typeof(SwaggerConfig).Assembly;

        GlobalConfiguration.Configuration 
            .EnableSwagger(c =>
                {
                    // By default, the service …
Run Code Online (Sandbox Code Playgroud)

swagger swagger-ui asp.net-web-api2 asp.net-core-mvc

7
推荐指数
2
解决办法
7856
查看次数