webAPIは自動的にヘルプドキュメントを生成します

クズども · 掲載地 2016/10/06 15:08:16

以前はWebAPIを使ってプロジェクト内のインターフェースを提供し、プロジェクト内ではWebapiメソッドやコメントに基づいたヘルプドキュメントの自動生成があり、非常に強力なWebapiメソッドのテストも可能であることを発見しました。これからそれらを皆さんと共有します。

まずは生成されたwebapiのドキュメントを見てください。

1. 以下の図は生成ヘルプドキュメントのトップページを示しており、Valuesがコントローラー、API下のリストにはhttpメソッド(Get、POSTなど)、リクエストのアクション、メソッドの説明が示されています。

2. 赤いボックス内のリンクをクリックすると、下図のようにAPIメソッドの詳細ページを開きます。

3. テストAPIをクリックして次のページを開きます

4. パラメータを入力し、送信ボタンをクリックし、次のページを開くと返り値が表示されます。

設定の手順は以下の通りです:

開発環境 VS2012 + MVC4 + WEB API

1. NuGetを通じてWeb APIテストクライアントを参照する

DLLを参照すると、次のようなファイルが生成されます:

こちらがヘルプドキュメントのインターフェースです

2. プロジェクトプロパティで以下の設定を行い、XMlドキュメントファイルを確認し、パスを設定します

3. プロジェクトのApp_Dataフォルダの下にXmlDocument.xmlを作成する

4. AreasHelpPageApp_StartHelpPageConfig.csファイルを開いて、以下のコードコメントをキャンセルします

プロジェクトを実行して http://localhost:3619/Help を開くと、自動的に生成されるAPIドキュメント、つまり記事の画像が表示されます

プロジェクトダウンロード:

WebAPIHelper.part2.rar (893.15 KB, ダウンロード数: 1)

WebAPIHelper.part1.rar (1.5 MB, ダウンロード数: 0)

[WebAPI] webAPIは自動的にヘルプドキュメントを生成します