問題タブ [asp.net-web-api-helppages]

Web API ヘルプ ページの追加情報については、こちらをお読みください。データ注釈は、実際には文書化のための追加情報を提供します。しかし、データ注釈なしで追加情報を提供する方法があることを知りたいですか?

はいの場合、どのように？

そうでない場合は、追加情報をデータ注釈でオーバーライドする方法があります。

追加情報に必須と書いてありますが、「この項目は必須です」とか表示したい場合はどうすればいいですか？

ありがとう

編集画像を参照可能であれば、データ注釈なしでその追加情報を更新したいと思います。

Team Foundation Server 2013 を使用しており、Web アプリケーションを展開するようにナイトリー ビルドを構成しています。Web アプリケーションは、組み込みの XML ドキュメント ファイルに依存する Web API ヘルプ ページを利用しています。

現在、これらの XML ファイルが App_Data フォルダーに出力されています。これらは、展開中にサーバーにコピーされません。ドキュメント ファイルをチェックインしようとしましたが、ビルド プロセスがそれらを再生成しようとすると、ファイルが読み取り専用であるため、アクセス エラーが発生しました。

現在、プロジェクトに含まれる App_Data フォルダー内にプレースホルダー テキスト ファイルが含まれており、フォルダーが確実に作成されるようにしていますが、ヘルプ ページが意図したとおりに機能するためには、ドキュメント ファイル全体を手動でコピーする必要があります。

これらのファイルを強制的にコピーする正しい/最良の方法は何ですか?

ありがとう

http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pagesの記事を読みましたが、問題なく動作します。しかし、これらの応答が送信されるときに、考えられるすべての応答と条件を追加したいと思います。各WebAPIメソッドを分析し、応答のあるすべての場所を見つけ、なぜそれが発生し、それに関するドキュメントを自動的に作成するツールはありますか?

つまり、次のコードがあります。

メソッドが返すことを説明するドキュメントが必要です。

1. StatusCode = 200 およびメソッドが正常に完了し、要素が見つかった場合の要素のリスト
2. StatusCode = 204 メソッドが正常に完了し、要素が見つからない場合
3. 場所が見つからない場合は StatusCode = 400 (編集リクエストを取得するための条件)、メッセージと CustomStatusCode を含む詳細な応答

Microsoft の webapi ヘルプ ページ nuget パッケージを使用しています。

最近新しいコントローラーを追加したとき、ヘルプ ページのすべてのルートが 2 回表示されます。

と

これらの重複を削除するにはどうすればよいですか?

驚いたことに、昨年追加したいくつかの古いコントローラーでは、それは起こりませんでした。

私が考えることができる唯一の違いは、新しいコントローラーdynamicで応答タイプとして使用したResponseTypeAttributeことですが、ヘルプページでもDTOモデルが正しく表示されるように使用しました。

当面は基本認証を使用する web api プロジェクトを作成しました。nuget パッケージを使用して Web Api ヘルプ ドキュメントを生成したため、Web Api ヘルプの新しい領域、コントローラー、およびビューが追加されました。IIS で Web API をホストしています。現在、Web Api の URL " http://localhost/WebApi/Help "を参照するだけで、誰でも Web Api ヘルプを参照できます。ヘルプ ページ (MVC で実装されている) を認証する必要があります。ここでの質問は、Web API が基本認証を使用しており、Web API ヘルプ ページの要求の前に Web API ヘルプが認証されるようにメカニズムを作成したいということです。

これを実現するために、「AccountController」、「Login」ページを作成しました。また、認証フィルターを作成し、「HelpController」(ヘルプ ページを表示するためのすべてのアクションを含む) を装飾しました。ログインページコード:

WindowsIdentity クラスを継承するアイデンティティ用のクラスを作成しました

有効な資格情報を入力した後にログインをクリックすると、ヘルプコントローラーのインデックスアクションにリダイレクトされます。認証フィルターがあるので、最初に「OnAuthentication」メソッドを呼び出します。ここでは、常に「context.HttpContext.User.Identity.IsAuthenticated」フラグを false として取得しています。認証フィルタ属性は次のとおりです。

入力してください。

asp.net Web API アプリケーションのドキュメント ツールまたはジェネレーターを探しています。このツールでは、API メソッドまたはパラメーターの説明/概要を編集できる必要があります。これは、PM や QA などのさまざまなチームがドキュメントを編集できるようにするために必要になる場合があります。これにより、必ずしも開発者である必要はありません。

この要件をサポートする優れたツールを提案してください。

ASP.NET ヘルプ ページを既存の MVC プロジェクトで実行するように設定しようとしていますが、同じソリューション内の Web API プロジェクトのドキュメント ファイルを指しています。規約には、文書化されている Web API 内で実行されるヘルプ ページがありますが、この場合は兄弟 MVC プロジェクトでそれが必要です。

Web API プロジェクトは、そのドキュメント XML ファイルを MVC プロジェクト内のフォルダーに出力します。

MVC プロジェクトにMicrosoft.AspNet.WebApi.HelpPage NuGet パッケージをインストールしました。これにより class が作成され、\Areas\HelpPage\App_Start\HelpPageConfig.csこのクラスのRegisterメソッド内でXmlDocumentationProvider、Web API のドキュメント ファイルへのパスを渡しました。

しかし、ページを読み込むと、タイトルとプレースホルダーの説明を除いて、ページは空です。

メソッドをデバッグすると、返されたが空HelpController.Indexであることがわかります。IApiExplorer_apiDescriptions

ただし、ヘルプ ページを Web API プロジェクトに直接インストールして同じメソッドをデバッグすると、 が存在することがわかり_apiDescriptionsます。

Web API プロジェクトが何を行っているか、MVC プロジェクトが行っていない、または構成していない構成を説明できる人はいますか?

以前にもここに来たことがありますが、今回は以前よりも遠くまで行くことができました。私はこのガイドに従っており、そこに書かれていることはすべて実行しました。http://localhost:61589/helpに移動すると、実際にヘルプ ページが表示されますが、紹介のみで、説明はありません。

私のコントローラーには、次のようなコメントがあります（常にそうです）：

生成された XmlDocument.xml には、次のメンバーがあります。

しかし、それらは実際のヘルプ ページには表示されません。なぜこれが起こっているのか誰にも分かりますか？