私はちょうどASP.NET 5で作業を始めました。私のメソッドのヘルプページが必要です。ヘルプページを作成する例はほとんどありませんが、ほとんどはMVC固有のものです。私はMicrosoft.AspNet.WebApi.HelpPage
パッケージを通過しました、それはヘルプページの領域を作成しますが、私はMVCパターンを使用していません。ASP .NET 5 WEB APIヘルプページを作成
このアドバイス以外のヘルプページを作成するにはどうすればよいですか?
私はちょうどASP.NET 5で作業を始めました。私のメソッドのヘルプページが必要です。ヘルプページを作成する例はほとんどありませんが、ほとんどはMVC固有のものです。私はMicrosoft.AspNet.WebApi.HelpPage
パッケージを通過しました、それはヘルプページの領域を作成しますが、私はMVCパターンを使用していません。ASP .NET 5 WEB APIヘルプページを作成
このアドバイス以外のヘルプページを作成するにはどうすればよいですか?
私はSwaggerとSwaggerUIを見ることをお勧めします。 Swaggerはオープンスタンダードで、JSONを使用してPayPalやMicrosoftのようなAPIをドキュメント化しています(紺碧のポータルでLogic appsをチェックしてください)。
自己は自分のプロジェクトとコンフィギュレーションの少しにNuGetパッケージを追加することによって、あなたのAPIを文書化します(私が使用しているどちらも)ネットのためのいくつかのオープンソース実装があります:
SwaggerUI(これはSwashbuckleにも含まれています)は、APIのナビゲートとテストに使用できるインターフェイスを追加します。デフォルトでは、プロジェクトの実行中には/ swagger/uiから利用できます。ここで
が、私はそれがどのように使用できるかを示すまとめGitHubの中のサンプルのレポです:https://github.com/mattridgway/ASPNET5-SwaggerUI
Swaggerは素晴らしいですが、WebAPIのカスタマイズではそれほど多くの適応作業がなくてもうまく動作せず、悲しいことにすべてを適応させることはできません。 WebAPIのプロバイダは完全にカスタマイズ可能であるため、HelpPageパッケージを完全に置き換えることはできません。 –
はあなたが必要とする何か他のものがあり、あなたは正しいものとして以下の私の答えをマークするだろうか? –