ASP.NET Core RC2 WebAPIでSwaggerを利用する
2016年6月7日~9日にかけてdotnetConf2016というイベントがありました。
セッション内容はChannel9で公開されているので気になる方は見てみましょう。
今回は最近のAPI開発周りでよく耳にするSwaggerを利用してみたいと思います。
従来のASP.NETでもSwaggerを利用する事はできましたが、基本的な流れは変わりません。Swaggerの説明はみそ先生のブログが参考になるでしょう。
手順
- Nugetパッケージマネージャーで
Swashbuckle
をインストールする Startup.cs
にSwaggerを利用する設定を追記/swagger/ui
にアクセスするとSwaggerUIが表示される
1.NugetでSwashbuckleをインストール
Install-Package Swashbuckle -Pre
.NET Core版はまだbetaなので-Pre
オプションを付けましょう
2. Startup.cs
にSwaggerを利用する設定を追記
サービスの設定でSwaggerGenServiceCollectionExtensions.AddSwaggerGen
を呼び出して。
アプリケーションの設定でSwaggerGenBuilderExtensions.UseSwaggerGen
とSwaggerUiBuilderExtensions.UseSwaggerUi
を呼び出せばOKです。
public void ConfigureServices(IServiceCollection services) { // Add framework services. services.AddMvc(); services.AddSwaggerGen(); // Add } public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory) { loggerFactory.AddConsole(Configuration.GetSection("Logging")); loggerFactory.AddDebug(); app.UseMvc(); app.UseSwaggerGen(); // Add app.UseSwaggerUi(); // Add }
3. /swagger/ui
にアクセスするとSwaggerUIが表示される
コンフィグの方法がCoreでよく利用するDIになっている以外は基本的に従来と同じで簡単ですね。
- 作者: 水野貴明
- 出版社/メーカー: オライリージャパン
- 発売日: 2014/11/21
- メディア: 大型本
- この商品を含むブログ (7件) を見る