Mac で ASP.NET Core を動かしてみた

公式のチュートリアル手順で簡単に動かせると思っていましたが、環境構築に少し手間取ったので、まとめておきます。
Your First ASP.NET Core Application on a Mac Using Visual Studio Code — ASP.NET documentation

環境構築

最近購入した MacBook Pro を MacOS Sierra にアップグレードしたので、ほぼクリーンインストールな環境です。

1. nodejs
こちらのリンクからインストーラーをダウンロードして、インストールします。

2. Homebrew
次のコマンドで Homebrew をインストールします。

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

3. OpenSSL
次のコマンドで OpenSSL をインストールします。

brew update
brew install openssl
ln -s /usr/local/opt/openssl/lib/libcrypto.1.0.0.dylib /usr/local/lib/
ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/

4. .NET Core SDK
こちらのリンクから official installer をダウンロードして、インストールします。
しかし、インストールしただけでは、ターミナルで dotnet コマンドを認識しません。
そのため、次のコマンドでパスを通す必要があります。

ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/

以上で、必要最低限の環境構築が完了しました。

Hello World

これでやっと、Hello World のプログラムを動かすことができます。

mkdir hwapp
cd hwapp
dotnet new
dotnet restore
dotnet run

Visual Studio Code

クロスプラットフォームなエディターの Visual Studio Code をインストールします。
code.visualstudio.com
合わせて、C# の拡張機能もインストールしておきます。
marketplace.visualstudio.com
インストールしただけでは、ターミナルで code コマンドを認識しません。
そのため、VS Code を起動して、［Command］＋［Shift］＋［P］キーを入力し、code コマンドをインストールします。

Shell Command: Install 'code' command in PATH

あと、Dock から VS Code を起動するには、展開した ZIP ファイルの .app ファイルを [アプリケーション] フォルダに移動する必要があります。

Yeoman

Web アプリのテンプレートを自動作成してくれる Yeoman をインストールします。
ASP.NET Core のジェネレータと Bower も合わせて、次のコマンドでインストールします。

npm install -g yo generator-aspnet bower

しかし、インストールに失敗してしまいます。

どうやら、インストール先のディレクトリにアクセス権限がないようです。
ググってみると、いくつかの対応方法がありましたが、今回は sudo コマンドでインストールすることにしました。

sudo npm install -g yo generator-aspnet bower

ASP.NET Core MVC を実行する

Yeoman を使ってスキャフォールディングした ASP.NET Core MVC のアプリケーションを作成します。

yo aspnet

Web Application → Bootstrap (3.3.6) を選択して、プロジェクトを作ります。

NuGet パッケージを復元してアプリを実行します。

cd webapp
dotnet restore
dotnet run

ブラウザから localhost:5000 にアクセスすると、次のような画面が表示されます。

一旦アプリを終了し、次のコマンドで VS Code を起動します。

code .

ブレイクポイントを置いて実行すると、デバッグを止めることができます。

まとめ

ASP.NET Core には期待しているので、Mac にも少しずつ慣れながら、試していきたいと思います。

ファイルをアップロードする API の Swagger ドキュメントを書く

ASP.NET Web API では、Swashbuckle を使って Swagger ドキュメントを作成します。
具体的な手順は、過去の記事を参照してください。
gooner.hateblo.jp

ASP.NET Web API で実装したファイルをアップロードする API のドキュメントを Swagger で書く方法を調べました。
multipart / form-data を使って、ファイルのバイナリデータを送信して、Azure Blob Storage にアップロードするシナリオです。

[HttpPost]
[Route("upload")]
public async Task<IHttpActionResult> Upload()
{
    if (Request.Content.IsMimeMultipartContent() == false)
    {
        throw new HttpResponseException(HttpStatusCode.UnsupportedMediaType);
    }
 
    var provider = await Request.Content.ReadAsMultipartAsync();
    var fileContent = provider.Contents.First(x => x.Headers.ContentDisposition.Name == JsonConvert.SerializeObject("buffer"));
    var buffer = await fileContent.ReadAsByteArrayAsync();
 
    var blob = this.container.GetBlockBlobReference("test.jpg");
    blob.Properties.ContentType = fileContent.Headers.ContentType.MediaType;
    await blob.UploadFromByteArrayAsync(buffer, 0, buffer.Length);
 
    return Ok();
}

Swagger ドキュメントをカスタマイズする

Swashbuckle の IOperationFilter インターフェイスを利用すると、Swagger メタデータ プロセスのさまざまな部分をカスタマイズできる拡張ポイントが提供されます。
IOperationFilter インターフェイスを継承した UploadFileOperationFilter クラスを実装しました。

public class UploadFileOperationFilter : IOperationFilter
{
	public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
	{
		operation.consumes.Add("multipart/form-data");
		operation.parameters = new[]
		{
			new Parameter
			{
				name = "buffer",
				@in = "formData",
				required = true,
				type = "file",
				description = "アップロードするファイル"
			},
		};
	}
}

Content-Type に multipart / form-data を追加し、パラメータを設定しています。入力形式に formData、タイプに file を指定するところが肝です。
そして、SwaggerOperationFilter 属性を使って、先ほどのアクションメソッドに UploadFileOperationFilter を指定します。

[HttpPost]
[Route("upload")]
[SwaggerOperationFilter(typeof(UploadFileOperationFilter))]
public async Task<IHttpActionResult> Upload()
{
}

Swagger ドキュメントでは、次のように表示され、参照ボタンからファイルを選択して API をテスト実行できます。

まとめ

クエリパラメータや JSON のリクエストボディであれば、アクションメソッドの引数から Swashbuckle がドキュメントを作ってくれますが、ファイルアップロードの場合には、カスタムの OperationFilter を実装する必要があります。
まとまった情報がなく、トライアンドエラーした結果なので、もしかしたら別のアプローチがあるかもしれません。

追記：ASP.NET Core の場合

gooner.hateblo.jp

JAZUG 6周年総会で Azure Functions の話をしてきました

jazug.connpass.com
先週の土曜日、JAZUG 6周年総会に参加して、Azure Functions の話をしてきました。

speakerdeck.com

サーバーレスや　Azure Functions の話題は、他のセッションでも挙がっていたので、話しやすい流れでした。PaaS でも十分便利ですが、マイクロサービス的に連携するサービスが増えていくと管理が大変になるので、自動化というアプローチに加えて、サーバーレスも活用していきたいです。

本編では、事例セッションの話が面白かったですし、意外とオーソドックスな構成で作っているものが多かった印象です。おばかIoTのように無駄に技術を使うアイディアは好きですし、LT大会もいろいろなネタがあり楽しめました。６年間のうち、JAZUG に参加しているのは半分ぐらいですが、これからもゆるふわなコミュニティを盛り上げていけるようにお手伝いしていきたいと思います。