1

初めてswaggerを使い始めたばかりですが、XmlDocumentionコメントから実装ノートに何かを表示させる方法がわからないようです。

json出力の特定のフィールドにデータを入力する方法についての言及がないまま、ドキュメントを数時間精査しました。

これを動的に実行し、このデータの静的jsonファイルを作成する必要はありません。特定の出力を取得するために指定するフィールドに関するチュートリアルまたは追加のドキュメントがあります。

また、UI出力のアクションメソッドの入力モデルに基づいてサンプルのjsonリクエストを手動で表示することなく表示する方法もあります。

編集：

また、私が遭遇した別の問題は、Authorize Swagger UIとしてマークされた単純なgetメソッドが完全に壊れ、javascript apiのheadersオプションにAuthorizeヘッダー（Bearerトークンを使用しています）を追加しようとすると、承認トークンが発生することです。送信されないコードは次のとおりです

        $(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であり、ヘッダーコレクションにはまったく存在せず、ベアラートークンはこれまで正常に機能していましたが、Fiddlerを使用すると、SwaggerAPIで何かを行う必要があります。それで私は行方不明です私は手紙にほぼ正確にドキュメントに従いました、そして上記の機能は認証以外でうまく働きます、そして私は実装ノートを移入する方法を理解することができません

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 に答える