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件) を見る
Build 2016で発表された、Micorosft Bot Frameworkが楽しそうだったので少し動かしてみた
日本時間の昨夜からBuild 2016が開催されました。
Keynoteの様子や全体のまとめはぶちざっきを見ると良いかと思います。
//build/ 2016 Day 1 Keynote | ブチザッキ
//build/ 2016 Day 1 で発表されたリンクあれこれ | ブチザッキ
色々な発表があったのですが、この中で私が注目したのは「Microsoft Bot Framework」
ChatOpsという言葉もありますが、最近はSkypeやSlackなどチャットツールの利用頻度が圧倒的に高くなっていますし、Hubotを利用してSlackのBotを作成している方も少なからず居ると思います。
今回発表されたMicrosoft Bot FrameworkではC#やNode.jsを利用して簡単にBotを作成する事ができます。かつ、作成したBotは登録する事で他のWebサービスと簡単に連携する事ができます。
サンプルを少し触ってみたのでご紹介します。詳細な説明は他の方がやってくれることでしょう・・・。
GitHubにサンプルコードもあるので眺めてみるとBot周りのASP.NET WebAPIクラスが増えているのが確認できます。
ソリューション構成
ASP.NET WebAPIで開発したことある方ならお馴染みのソリューション構成です。
コントローラーの中身はこんな感じ。
using System; using System.Linq; using System.Threading.Tasks; using System.Web.Http; using Microsoft.Bot.Builder.Dialogs; using Microsoft.Bot.Connector; using Microsoft.Bot.Connector.Utilities; namespace Microsoft.Bot.Sample.EchoBot { [BotAuthentication] public class MessagesController : ApiController { /// <summary> /// POST: api/Messages /// receive a message from a user and reply to it /// </summary> public async Task<Message> Post([FromBody]Message message) { return await Conversation.SendAsync(message, () => new EchoDialog()); } } }
Microsoft.Botの名前空間にBot周りのクラスが定義されています。
BotAuthentication属性やMessageクラス、Microsoft.Bot.Builder.Dialogs.IDialogを実装しているクラス（ここではEchoDialog）
Botの主な動作はMicrosoft.Bot.Builder.Dialogs.IDialogのStartAsyncを実装してIDialogContext.Wait(ResumeAfter<Message> resume)を呼び出すことで動作します。
ResumeAfterはジェネリクスで指定されている型の引数とIDialogContextのデリゲートです。
public delegate Task ResumeAfter<in T>(IDialogContext context, IAwaitable<T> result);
サンプルソースを参考にして実装するとこんな感じです
public async Task StartAsync(IDialogContext context) { context.Wait(MessageReceivedAsync); } public async Task MessageReceivedAsync(IDialogContext context, IAwaitable<Message> argument) { var message = await argument; // << ここで入力された内容を処理する >> // メッセージを返却する await context.PostAsync(string.Format("入力したメッセージは {0} ねっ？", message.Text)); // 入力待ち状態で入力を受け付ける context.Wait(MessageReceivedAsync); }
デバック方法
BotのEmulatorツールが公開されています。
作成したWeb APIをビルド＆デバック状態にしてEmulatorからBotと会話する事が出来ます。（単純に指定したエンドポイントにPOSTリクエストを投げているだけっぽい？）
公開＆連携
今回は以下のページを参考にしてAzure WebAppで作ったAPIをホストして、Bot FrameworkのページからBotの登録を行いました。
登録するとAPIIDとKeyが発行されるのでWeb.configを書き換えましょう。
<?xml version="1.0" encoding="utf-8"?> <!-- For more information on how to configure your ASP.NET application, please visit http://go.microsoft.com/fwlink/?LinkId=301879 --> <configuration> <appSettings> <!-- update these with your appid and one of your appsecret keys--> <add key="AppId" value="hanayobot" /> <add key="AppSecret" value="YourAppSecret" /> </appSettings>
後は管理画面右側の連携したいサービスからADDすれば追加できます。Web Hook対応のサービスからなら登録できるはずなのでBotライフを楽しみましょう
うまくできなかった事
- 管理画面の「Test connection to your bot」で会話できるはずなのですが、sendボタンを押しても無反応だった・・・
- Web Chatで作成されたタグを仕込んでもbotが無反応だった。
認証系っぽい…。
Twilioの自動音声を日本語で行う方法（C#版）
Twilioのネタも4回目になります。 1回目の記事で自動音声の日本語にできないかと思っていたのですが、ドキュメントに載っていたのでご紹介します。
２回目の記事はこちら（そのうち目次エントリ作ると思います）
TwiXMLを返却するActionメソッドを作成する。
public ActionResult Index() { var response = new TwilioResponse(); response.Say("こんにちは", new { voice = "alice", language = "ja-JP" }); response.Say("さようなら", new { voice = "alice", language = "ja-JP" }); response.Say("漢字も話すことができますよ。", new { voice = "alice", language = "ja-JP" }); response.Say("こんにちは", new { voice = "man", language = "ja-jp" }); response.Say("さようなら", new { voice = "man", language = "ja-jp" }); response.Say("漢字も話すことができますよ。", new { voice = "man", language = "ja-jp" }); response.Say("こんにちは", new { voice = "woman", language = "ja-jp" }); response.Say("さようなら", new { voice = "woman", language = "ja-jp" }); response.Say("漢字も話すことができますよ。", new { voice = "woman", language = "ja-jp" }); return TwiML(response); }
該当のドキュメントはこちら
Twilio Cloud Communications - APIs for Voice, VoIP, and Text Messaging
ドキュメントには男性の日本語が使えるとあるけれど・・・
ドキュメントにはmanとwomanの場合は日本語も使用できると書いてあったり。
manとwoman英語、スペイン語、フランス語、ドイツ語、イタリア語が使用できる（日本語不可）とあったり
動詞では、2種類の別々のボイスエンジンが選べます。まず man と woman、これらは共に 英語、スペイン語、フランス語、ドイツ語、イタリア語 で利用できます。
情報が混在してますが、実際に試した感じだと日本語はaliceの場合のみ対応しているようです。
参考程度ですが、今回のActionResultが返すTwiMLはこのようになります。
<?xml version="1.0" encoding="utf-8"?> <Response> <Say voice="alice" language="ja-JP">こんにちは</Say> <Say voice="alice" language="ja-JP">さようなら</Say> <Say voice="alice" language="ja-JP">漢字も話すことができますよ。</Say> <Say voice="man" language="ja-jp">こんにちは</Say> <Say voice="man" language="ja-jp">さようなら</Say> <Say voice="man" language="ja-jp">漢字も話すことができますよ。</Say> <Say voice="woman" language="ja-jp">こんにちは</Say> <Say voice="woman" language="ja-jp">さようなら</Say> <Say voice="woman" language="ja-jp">漢字も話すことができますよ。</Say> </Response>
この状態で電話をかけるとすべてAliceの音声で再生されます。
