WPFを中心に書いています。Technologies。APIそ使う」の第2回となります。APIに対してSwaggerを適用します。SwaggerとはRESTfulなAPIを管理する多岐にわたる成果物群のことで、API仕様記述の標準仕様やそのエディター、API仕様をWeb公開するためのユーザーインターフェースや、API仕様から各種言語のソースコードを自動生成するツールなどを含みます。MicrosoftやGoogleも立ち上げに関与しているそうです。APIアプリケーションへSwaggerのAPIドキュメント生成機能を適用し、次回のクライアントコード自動生成の事前準備を行います。APIプロジェクトへ簡単に適用するために、NuGet上に「Swashbuckle」というライブラリが公開されています。このライブラリをインストールします。HelloWebApiプロジェクトを右クリックし「NuGetパッケージの管理...」を選択してください。開かれたページでつぎの手順で「Swashbuckle」を検索し、インストールします。ドキュメントファイル」を有効化SwaggerのAPIドキュメントには、ソースコード上のXMLコメントが利用されます。ドキュメントファイル」を有効化します。有効化しなかった場合、詳細な説明は表示されませんがコード生成に必要な情報は利用可能です。ドキュメントファイル」を有効化します。ドキュメントファイルのパスが設定されます。ドキュメントファイル」を生成しなくともSwaggerのドキュメントは生成されます。ドキュメントファイル」を読み込む設定になっていないため、読み込み設定を有効化します。エクスプローラーで「App_Start」フォルダを開き「SwaggerConfig.cs」ファイルを開いてください。ファイル内で「IncludeXmlComments」を検索すると、つぎのような箇所が見つかるはずです。files.////c.IncludeXmlComments(GetXmlCommentsPath());この最後の行のコメントを解除します。files.//c.IncludeXmlComments(GetXmlCommentsPath());この状態では「GetXmlCommentsPath」メソッドが存在しないため、クラスの末尾につぎのように新しく作成します。commentsFilePath;}以上でSwaggerの適用は完了です。SwaggerのAPIドキュメントを確認するF5キーを押下してデバッグを開始し、つぎのURLを閲覧してください。http://localhost:9000/swaggerすると、つぎのような画面が表示されます。APIの各仕様が閲覧できます。/api/Employees」を選択してみてください。つぎのように詳細な仕様が閲覧できます。ここまでは「人間向け」のドキュメントでしたが、上のページの上部に表示されている、つぎのアドレスを表示するとプログラムから解析するためのJSON形式のAPIドキュメントを閲覧することができます。http://localhost:9000/swagger/docs/v1見やすいように変換すると、つぎのようなJSONになります。...ここでは詳細な解説は行いませんが、なんとなく意図は理解できるのではないでしょうか。これでSwaggerの適用は完了です。次回は、Swaggerの設定情報からクライアントコードを自動生成する方法を紹介します。(1)はてなブログをはじめよう!nuitsjpさんは、はてなブログを使っています。ブログを報告するスターをつけました引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。