【问题标题】:Swagger.net - how to specify UI notes in the xml commentsSwagger.net - 如何在 xml 注释中指定 UI 注释
【发布时间】:2012-12-08 17:49:07
【问题描述】:

我刚开始第一次使用 swagger,似乎无法弄清楚如何让实现说明通过 Xml Documention cmets 显示任何内容。

我已经搜索了几个小时的文档,但没有看到任何提及如何填充 json 输出中的特定字段。

我希望动态完成,不想为此数据创建静态 json 文件 是否有关于指定哪些字段以获得特定输出的教程或其他文档。

还有一种方法可以根据输入模型在 UI 输出中的操作方法上显示示例 json 请求,而无需手动显示这些

编辑:

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

        $(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中是否发生了一些事情,我需要做一些我错过的事情我已经按照文档几乎完全按照字母进行操作,上面的功能除了身份验证之外工作正常,我无法弄清楚如何填充实施说明

【问题讨论】:

    标签: .net asp.net-mvc-4 asp.net-web-api swagger


    【解决方案1】:

    source code 看来,实现说明是由您的 cmets 的 元素提供的。例如:

    /// <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-client.js 也有实现注释。只有 swagger-ui.js 有这个。
    猜你喜欢
    • 1970-01-01
    • 2015-09-19
    • 2012-01-24
    • 2016-01-10
    • 2013-06-24
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2013-08-01
    相关资源
    最近更新 更多