SQL Server では公式のサンプルデータベースがGithubで複数公開されています。
本エントリーではSQL Serverのインストールから、サンプルデータベースの「Adventure Works 2017」を利用する方法について解説します。
ちなみに Adventure Works は非常に素直な？データベース設計です。ただしSQL Server の最新の機能を使いこなしているとは言えません。そういう用途では World Wide Importers が参考になります。World Wide Importers も本エントリーの手順で利用できますので、興味のある方はお試しください。
続きを読む
本エントリーは連載「ASP.NET Web APIを使おう」の第3回となります。連載の目次はこちら。
さて今回はWeb APIでもAspect Oriented Programing（AOP）をする為、Simple Injector 上でCastle.CoreのDynamicProxyを利用する方法を解説します。実際のところ、Web API に依存する内容ではないため、例えばWPFなどでもSimple Injectorを利用するなら、この方法はそのまま使えます。
という訳で早速始めましょう。
続きを読む
本エントリーは連載「ASP.NET Web APIを使おう」の第3回となります。連載の目次はこちら。
さて今回は、Web API の利用にあたり統合 Windows 認証を適用する方法を説明します。
続きを読む
本エントリーは連載「ASP.NET Web APIを使おう」の第3回となります。連載の目次はこちら。
これまでWeb APIを作成し、swagger-codegenを使って生成したクライアントから、作成したAPIを呼び出す方法について説明してきました。
今回はWeb APIつまりサーバーサイドにDependency Injection（DI）コンテナを適用する方法を解説します。DIコンテナーには Simple Injector を今回は選択しました。
DIコンテナは星の数ほどありますが、なぜ Simple Injector を選択したかは、以下の記事をご覧ください。
こちらに記載している内容に加え、次のような観点から Simple Injector を取り上げました。
なお本エントリーでは、DI そのものの解説や、Simple Injector の詳細な解説は省きます。
続きを読む
本エントリーは連載「ASP.NET Web APIを使おう」の第3回となります。連載の目次はこちら。
さて第1回・第2回でWeb APIを作成し、SwaggerのAPIドキュメントを公開する方法を解説してきました。今回は、これまで作成したWeb APIに対してswagger-codegenを利用して、C#用のクライアントコードを生成し、実行する方法を解説します。
ところでVisual Studioには標準でSwaggerのAPIドキュメントから、RESTクライアントのコードを生成する機能が存在します。しかし今回は、次の理由から利用せずswagger-codegenを利用する事にしました。
それでは実際の作り方を説明していきます。
続きを読む
本エントリーは連載「ASP.NET Web APIそ使う」の第2回となります。連載の目次はこちら。
さて今回は、第1回で作成したWeb APIに対してSwaggerを適用します。
SwaggerとはRESTfulなAPIを管理する多岐にわたる成果物群のことで、API仕様記述の標準仕様やそのエディター、API仕様をWeb公開するためのユーザーインターフェースや、API仕様から各種言語のソースコードを自動生成するツールなどを含みます。MicrosoftやGoogleも立ち上げに関与しているそうです。
今回は前回作成したASP.NET Web APIアプリケーションへSwaggerのAPIドキュメント生成機能を適用し、次回のクライアントコード自動生成の事前準備を行います。
SwaggerをASP.NET Web APIプロジェクトへ簡単に適用するために、NuGet上に「Swashbuckle」というライブラリが公開されています。まずはこのライブラリをインストールします。
HelloWebApiプロジェクトを右クリックし「NuGetパッケージの管理...」を選択してください。
開かれたページでつぎの手順で「Swashbuckle」を検索し、インストールします。
SwaggerのAPIドキュメントには、ソースコード上のXMLコメントが利用されます。詳細な仕様を有効にするため「XML ドキュメントファイル」を有効化します。なお有効化しなかった場合、詳細な説明は表示されませんがコード生成に必要な情報は利用可能です。
まずプロジェクトを右クリックして「プロパティ」を開き、つぎの手順で「XML ドキュメントファイル」を有効化します。
チェックすると自動的にXML ドキュメントファイルのパスが設定されます。
先にも記載した通り、「XML ドキュメントファイル」を生成しなくともSwaggerのドキュメントは生成されます。そのためデフォルトでは「XML ドキュメントファイル」を読み込む設定になっていないため、読み込み設定を有効化します。
ソリューション エクスプローラーで「App_Start」フォルダを開き「SwaggerConfig.cs」ファイルを開いてください。
ファイル内で「IncludeXmlComments」を検索すると、つぎのような箇所が見つかるはずです。
// If you annotate Controllers and API Types with // Xml comments (http://msdn.microsoft.com/en-us/library/b2s063f7(v=vs.110).aspx), you can incorporate // those comments into the generated docs and UI. You can enable this by providing the path to one or // more Xml comment files. // //c.IncludeXmlComments(GetXmlCommentsPath());
この最後の行のコメントを解除します。
// If you annotate Controllers and API Types with // Xml comments (http://msdn.microsoft.com/en-us/library/b2s063f7(v=vs.110).aspx), you can incorporate // those comments into the generated docs and UI. You can enable this by providing the path to one or // more Xml comment files. // c.IncludeXmlComments(GetXmlCommentsPath());
この状態では「GetXmlCommentsPath」メソッドが存在しないため、クラスの末尾につぎのように新しく作成します。
private static string GetXmlCommentsPath() { var baseDirectory = AppDomain.CurrentDomain.BaseDirectory; var commentsFileName = string.Format("{0}.XML", Assembly.GetExecutingAssembly().GetName().Name); var binFilePath = Path.Combine(baseDirectory, "bin"); var commentsFilePath = Path.Combine(binFilePath, commentsFileName); return commentsFilePath; }
以上でSwaggerの適用は完了です。
F5キーを押下してデバッグを開始し、つぎのURLを閲覧してください。
http://localhost:9000/swagger
すると、つぎのような画面が表示されます。
APIの各仕様が閲覧できます。試しに「Employee」→「GET /api/Employees」を選択してみてください。つぎのように詳細な仕様が閲覧できます。
ここまでは「人間向け」のドキュメントでしたが、上のページの上部に表示されている、つぎのアドレスを表示するとプログラムから解析するためのJSON形式のAPIドキュメントを閲覧することができます。
http://localhost:9000/swagger/docs/v1
見やすいように変換すると、つぎのようなJSONになります。
{ "definitions": { "Employee": { "properties": { "BirthDay": { "format": "date-time", "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } }, "type": "object" } }, "host": "localhost:9000", "info": { "title": "HelloWebApi", "version": "v1" }, "paths": { "/api/Employees": { "get": { "consumes": [], "operationId": "GetEmployees", "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Employee" }, "type": "array" } } }, "tags": [ "Employees" ] }, ...
ここでは詳細な解説は行いませんが、なんとなく意図は理解できるのではないでしょうか。
さてこれでSwaggerの適用は完了です。次回は、Swaggerの設定情報からクライアントコードを自動生成する方法を紹介します。
