SwaggerHubを使ってカンタンAPI公開

今回はSwaggerHubを紹介します。

SwaggerHubはSwagger Editor/UI/Codegenの機能がオールインワンになっています。つまり、Swagger SpecであるJSONやYAMLファイルをSwagger Editorで記述すると、ドキュメントもコードもSwagger UI/Codegenにより自動生成することができます。

さらには、チーム開発に関するAPI管理機能がクラウド基盤上で実装されているなど、APIエコノミーの時代においてAPI開発に欠かせないツールとなってきています。機能の全貌をつかんだ上で、インストールから動作確認までの手順をぜひ試してみてください。

SwaggerHubを使ってみる

SwaggerHubにアクセスすると世の中の開発者が作成したAPIが並んでいます。組織や国境を超えたチーム開発を実現し、APIエコノミー(経済圏)の体現していると言えるでしょう。

それでは早速、アカウントを作ってAPIを作ってみましょう。[SIGN UP]をクリックします。

必要事項を入力し、[SIGN UP]をクリックします。指定したEメールアドレスにメールが届きますので、アカウントを有効化してください。

作成したアカウントでSwaggerHubにログインし、[CREATE API]をクリックします。

バージョンや、テンプレートなどを指定して[CREATE API]をクリックします。

API作成され、Swager Editorと同様の画面が表示されます。左側のペインがエディタとなっています。

Swagger Spec 3.0仕様に準拠したYAML形式で記載されており、修正すると、右側のペインと同期されます。POSTやGETの/inventoryをクリックし、動作を試すこともできます。

配布済みとすることで仕様を確定させ、意図しない編集を避けることができます。[・・・]をクリックし、[Pubish]をクリックします。

なお、[Fork API]を実施することで、仕様をフォークさせることができ、[Make Private]により非公開にすることができます。

確認画面が現れますので、[PUBLISH VERSION]をクリックします。

[Share]欄にてAPIのURLを確認できます。また、[Collaborate]欄にてユーザを招待したり、ユーザの権限を設定したりできます。

SwaggerHubのライセンス体系

SwaggerHubのライセンス体系は以下の通りです。チーム開発を行うためにはTeamかEnterpriseが必要になってきます。FreeプランにはAPI数に限りがあり、あくまで検証用と言えるでしょう。

実開発で無料で利用したい場合は、SwaggerHubを使わずOSSであるSwaggerツール群を単独で利用することをお勧めします。

まとめ

SwaggerHubを使うと、Swagger Editor/UI/Codegenが一度に使えるだけでなく、クラウド基盤を用いてAPIのチーム開発が可能となります。Freeプランについては無償で使えますので、ぜひお手元で試してみてください。

次回は、APIの実行・テストのためのSwagger Inspectorを紹介します。