問題タブ [asp.net-mvc-apiexplorer]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
asp.net-web-api - ExpandoObject のドキュメントを作成するために ApiExplorer を説得する方法は?
ExpandoObject をパラメーターとして使用することで、Web.API プロジェクトに PATCH メソッドを実装する非常に巧妙な方法を作成しました。以下に示すように:
ただし、ドキュメントを生成するとき、ApiExplorer は ExpandoObject をどうするかについて途方に暮れています。これは完全に理解できます。ApiExplorer を操作して適切なドキュメントを提供する方法について、誰かアイデアはありますか?
私の考えは、期待される実際のタイプを指す新しい属性を導入することでした:
しかし、どこから始めればよいかわかりません。アイデアや提案は大歓迎です。
sitecore - サイトコアとスワッシュバックル
Swashbuckle を使用して Sitecore WebApi を文書化しようとしていますが、うまくいきません。Swashbuckle.Core
Nuget パッケージをインストールし、このロジックをInitialize
パイプライン プロセッサに追加しました。
を使用して、ルートにカスタム ルートを追加した後、このプロセッサを実行しますMapRoute
。SwashbuckleSystem.Web.Http.Description.ApiExplorer
がすべてのコントローラーとアクションのリストを取得するために使用することがわかりました。実際、標準の Sitecore API はすべてリストされていますが、カスタム ルートに追加されたカスタム コントローラーとアクションはリストされていません。経験のある方は、ApiExplorer
これをデバッグする方法を教えてもらえますか? この言及されたバグはまだ問題になる可能性がありますか? ApiExplorer
すべてのデフォルトの Sitecore API ではなく、カスタム コントローラーとアクションのみを出力するように を構成できますか?
前もって感謝します!
asp.net-core - ApiExplorer は ASP.NET Core 1.0 でサポートされていますか? また、その使用方法は?
ASP.NET Core 1.0 は APIExplorer の使用をサポートしていますか? ドキュメントや使用方法を見つけることができません。誰かがそれを使用していて、洞察を共有できますか?
c# - ASP.NET Web API のヘルプ ページの作成と戻り値の型のドキュメント化
API
メソッドの ヘルプ ページを作成するために、このASP.NET Web API のヘルプ ページの作成およびASP.Net WebApi ヘルプ ページ で説明されているように、xml ドキュメントが使用されています。私のapi's
署名の1つは次のようなものです:
PlacesViewModel
戻り値の型を文書化する必要があることを除いて、xml 文書は正しい です。実際にPlacesViewModel
は、ソリューション内の別のプロジェクトのビュー モデルです。xml コメントは、次のように提供されています。
しかし、それは機能せず、まるでxmlコメントがないかのようPlacesViewModel
に、表の説明の列の値が空のヘルプページにクラスが出席します。PlacesViewModel
なぜドキュメントを提供できるのかPlacesViewModel
同じプロジェクトに移動すれば、PlacesViewModel
うまくいきます!
c# - エンドポイントがバイナリ データ (zip ファイルなど) を返すことを Web API ApiExplorer に伝える方法は?
モデルを返すエンドポイントの場合、 を使用しResponseTypeAttribute
て、返されるデータがどのようになるかをヘルプ ページのドキュメントに伝えることができます。
これにより、このエンドポイントがどのように動作するかを説明する Api ヘルプ ページの適切なエントリが作成されます。
特定のエンドポイントがアプリケーション/zip バイナリ ストリームを返すことを文書化したいと考えています。どうやってやるの?