ASP.NET 5 の作業を始めたばかりです。メソッドのヘルプ ページが必要です。ヘルプ ページを作成する例はほとんど見たことがありませんが、それらのほとんどは MVC 固有のものです。パッケージを確認Microsoft.AspNet.WebApi.HelpPageしました。ヘルプ ページのエリアが作成されますが、MVC パターンは使用していません。
このエリアアプローチ以外のヘルプページを作成するにはどうすればよいですか?
1592 次
1 に答える
5
SwaggerとSwaggerUIを見ることをお勧めします。Swagger はオープン スタンダードであり、JSON を使用して API を文書化し、PayPal や Microsoft などで使用されています ( azure ポータルでロジック アプリを確認してください)。
.Net 用のオープン ソース実装がいくつかあります (どちらも私が使用しました)。これは、NuGet パッケージをプロジェクトに追加し、少し構成するだけで、API を自己文書化します。
Swashbuckle は元のプロジェクトで、Ahoy は ASPNET5 を対象とした新しいバージョンです。NuGet からパッケージをダウンロードしても Swashbuckle を取得できます。「プレリリースを含める」にチェックを入れてください。ドキュメントが必要な場合は、元の GitHub プロジェクトを参照してください。
SwaggerUI (Swashbuckle にも含まれています) は、API のナビゲートとテストに使用できるインターフェイスを追加します。デフォルトでは、プロジェクトの実行時に「/swagger/ui」から利用できます。
以下は、使用方法を示すためにまとめた GitHub のサンプル リポジトリです。
于 2016-02-08T22:06:44.890 に答える