えぞてくブログ

ITと北海道と日常と、そんな日々を綴ります

MacでVisual Studio Codeを使ってASP.NET(C#)でWeb APIを作ってみる(3)

■前回

前回はJWT認証ができたので、今度は Swagger / Open API を使用する ASP.NET Core Web API のヘルプ ページ を試してみようと思います。

blog.tyama.jp

■なぜ試してみるのか

API設計には Swaggerを使っています。「ASP.NET」「Swagger」で検索したところ、この 記事が見つかったので、使えそうかどうか試して見ようと思います。

■Swashbuckle

まずは Swashbuckle と ASP.NET Core の概要 です。 使い方はこの記事を見ればわかるので割愛して...「Swashbuckle」とは何ぞやというところで、端的に言うと

Web APIのコードから、Swagger UIを自動で生成するぜ!

ということになるかと思います。

■NSwag

次に NSwag と ASP.NET Core の概要 です。 こちらも使い方はこの記事を見ればわかるので割愛して...「NSwag」とは何ぞやというところで、端的に言うと

Swaggerで設計したAPIから、C#のクライアントコードとTypeScriptのコードを自動で生成するぜ!

ということになるかと思います。

ちなみに自分はMacユーザ...提供されているGUIWindowsアプリなため使えませんでした。
コマンドラインでも出来そうですが、今回自分には不要そうでしたので試していません。

■今後

最後の1つを進めていこうと思います。

  1. JWTで認証できるようにする。
  2. Swagger / Open API を使用する ASP.NET Core Web API のヘルプ ページ をやってみる。<- イマココ
  3. SQL Serverと接続してみる。(Docker)