web-dev-qa-db-ja.com

ASP.net WebAPIのドキュメントを自動生成

現在、ASP.NetにWebApiを使用しているMVCプロジェクトがあります。コントローラーのコードのほとんどは、c#で記述されています。次を含むAPI呼び出しの説明を自動的に生成したいと思います。

1.)ページ/エンドポイントのURL

2.)エンドポイント/ページの機能の説明

3.)説明とデータ型を含む引数のリスト。

4.)HTTP動詞(get、post、put、delete)

5.)ページに必要な権限

説明は手動で記述する必要があります。

個人がSwaggerのようなサードパーティアプリケーションを使用する結果となる他の記事をかなり読みました。これを支援するためにASP.Netに組み込まれているものはありますか?サードパーティのソフトウェアを使用せずに自分でドキュメントを生成したい場合、そのようなドキュメントの作成を開始するにはどうすればよいですか?

私はさまざまなクエリをグーグルで検索するのにかなりの時間を費やしましたが、答えが見つからないようです。

編集:私の場合、ASP.NetヘルプページよりもSwaggerを使用する利点は何ですか?

12
Speerian

Swaggerの代替として、 'Help Pages' for ASP.NET Web APIを使用できます。

このドキュメント内のエントリは自動的に生成され、次のような情報が含まれます。

  • 相対URI

  • HTTPメソッド

  • サンプルの要求/応答データ

  • APIの目的の説明(XMLコメントから派生)

サードパーティのコンポーネントを使用することができる場合可能であれば、 を使用することをお勧めしますSwaggerSwashbuckle NuGet package を使用してAPIドキュメントを作成します。

19
Jamie Keeling

Swaggerは、API URIをリストするだけではありません。ユーザーは実際にそれらを試して、応答を確認します

Swaggerには、ドキュメントを実装する前に作成するツールがあります。

コメントを使用して説明を追加することもできます。

5
Nick