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

从source code开始，＆lt; remarks /＆gt;提供了实施说明。你评论的要素。例如：

/// <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;
}

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

1 个答案: