How to include class and property descriptions in Swashbuckle generated Swagger documents for WebApi 2 with OWIN?

Question

Before you think about it, this one doesn't match.

I think this should be pretty much self-evident. I would like to include class descriptions in Swagger docs. My configurator Swaggerlooks like this:

config.EnableSwagger(c =>
{
    c.SingleApiVersion("v1", "My Api Name");
    c.OperationFilter<AddAuthorizationHeaderParameterOperationFilter>();
    c.IncludeXmlComments(GetXmlCommentsPath());

}).EnableSwaggerUi(c => { });

And MyAwesomeControllerit looks like this:

/// <summary>
/// Controller description (is included by Swashbuckle)
/// </summary>
public class MyAwesomeController : ApiController
{
    /// <summary>
    /// Method description (is included by Swashbuckle)
    /// </summary>
    public IHttpActionResult Get()
    {
        return Ok("hello... from the other side");
    }

    public IHttpActionResult Post([FromBody]MyAwesomeModel model)
    {
        return Ok("hello... from the other side");
    }
}

And mine MyAwesomeModellooks like this:

/// <summary>
/// **I would like this to be included in the Swagger description of the parameter**
/// </summary>
public class MyAwesomeModel
{
    /// <summary>
    /// **I would like this to be included in the Swagger description of the parameter**
    /// </summary>
    public string MyProperty { get; set; }
}

Is this possible without hiring Sr. Skeet?

Answer 1

Hm ... it could be if someone else comes across this.

, , , . , , .

POCOs , API, MyAwesomeModel , XML. , , POCOs, XML.

• XML , POCOs

2. , XML , Swashbuckle, . Post-build event command line ;

copy "$(SolutionDir)MyAwesomeProjectWithPocos\bin\MyAwesomeProjectWithPocos.xml" "$(ProjectDir)\bin\MyAwesomeProjectWithPocos.xml"

3. SwaggerConfig, XML,

..

config.EnableSwagger(c =>
{
    c.SingleApiVersion("v1", "My Api Name");
    c.OperationFilter<AddAuthorizationHeaderParameterOperationFilter>();
    c.IncludeXmlComments(GetXmlCommentsPath());
    c.IncludeXmlComments(GetXmlCommentsPathForModels());

}).EnableSwaggerUi(c => { });

, Swagger, Model Schema Model, .

, XML , # 3 GetXmlCommentsPathForModels());, .

Answer 2

c.IncludeXmlComments(GetXmlCommentsPath());

, xml xml, XML ?