Swagger.net - 如何在xml注释中指定UI注释

Question

我刚开始第一次使用swagger,似乎无法弄清楚如何通过Xml Documention注释获得实现说明来显示任何内容.

我已经搜索了几个小时的文档而没有看到如何填充json输出中的特定字段.

我希望动态完成此操作,并且不希望为此数据创建静态json文件是否有指导哪些字段以获取特定输出的教程或其他文档.

还有一种方法是根据UI输出中的动作方法的输入模型显示样本json请求,而无需手动显示这些

编辑:

我遇到的另一个问题是,如果我有一个简单的get方法标记为Authorize Swagger UI完全中断,当我尝试将Authorize标头(我使用Bearer标记)添加到javascript api中的headers选项时授权令牌永远不会被发送代码是一个跟随

        $(function () {
        window.swaggerUi = new SwaggerUi({
            discoveryUrl: "/api/swagger",
            dom_id: "swagger-ui-container",
            docExpansion: 'list',
            headers: { "Authorization":"Bearer Y2xtY2dyYXRoX2ZhY19jcmRJQ1RHV1MuQ29vcmRpbmF0b3IsRmFjdWx0eS42RC1BMi02Mi03Mi00Qi00Mg=="},
            supportHeaderParams: true,
            supportedSubmitMethods: ['get', 'post', 'put', 'delete']

        });


        window.swaggerUi.load();

    });

当我在我的消息处理程序中收到请求时,authHeader为null并且在headers集合中根本不存在,并且持有者令牌已经工作正常,直到现在使用Fiddler在swagger api中有什么东西我需要做某事我失踪了,我已经按照文件几乎完全按照文件和上面的功能工作正常除了身份验证,我无法弄清楚如何填充实施说明

Answer 1

从源代码看,实现注释看起来像是注释的<remarks />元素.例如:

/// <summary>
/// Gets the resource by the specified ID.
/// </summary>
/// <param name="id">The id.</param>
/// <remarks>These remarks end up in the implementation notes of swagger</remarks>
public string Get(int id)
{
    return "my resource at " + id;
}