1

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

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

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

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

编辑:

我遇到的另一个问题是,如果我有一个标记为 Authorize Swagger UI 的简单 get 方法完全中断,并且当我尝试将 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 为空,并且在标头集合中根本不存在,并且承载令牌一直运行良好,直到现在使用 Fiddler 是否在 swagger api 中发生了什么我需要做的事情我错过了我几乎完全按照文档进行操作,上面的功能除了身份验证之外工作正常,我无法弄清楚如何填充实施说明

4

1 回答 1

6

源代码中,您的注释中的 <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;
}
于 2012-12-20T17:01:33.533 回答