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

【連載】

Swagger 3.0 入門

【第2回】SwaggerHubを使ってカンタンAPI公開

[2018/08/30 09:00]正野 勇嗣 ブックマーク ブックマーク

  • 開発ソフトウェア

開発ソフトウェア

今回はSwaggerHubを紹介します。

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

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

Swaggerツール群の関係性(第一回の再掲)

<Swaggerの基本はこちらで!>

【連載】Swagger入門

SwaggerHubを使ってみる

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

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

Swagger Inspectorのトップページ

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

アカウント情報の入力

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

SwaggerHubのマイページ

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

新規APIの作成

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

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

作成したAPI

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

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

Publishメニュー

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

Publishメニュー

API公開設定ボタン

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

APIの公開URLとユーザの権限設定

SwaggerHubのライセンス体系

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

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

プラン別機能表

まとめ

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

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

著者紹介


正野 勇嗣 (SHONO Yuji ) - NTTデータ 課長

2011年まで開発自動化技術のR&Dに従事。その後、開発プロジェクト支援やトラブルシューティング等に主戦場を移す。「ソースコード自動生成」に加えて、JenkinsやMaven等の「ビルド自動化」、JsTestDriverやSelenium等の「テスト自動化」を扱うようになり、多様化する開発自動化技術動向に興味。

最近は第四の自動化であるInfrastructure as Code等の「基盤自動化」の魅力に惹かれている。開発自動化技術に関する雑誌・記事執筆も行う。2児のパパ。

※ 本記事は掲載時点の情報であり、最新のものとは異なる場合がございます。予めご了承ください。

関連リンク

この記事に興味を持ったら"いいね!"を Click
Facebook で IT Search+ の人気記事をお届けします
3978
2
【連載】Swagger 3.0 入門 [2] SwaggerHubを使ってカンタンAPI公開
今回はSwaggerHubを紹介します。SwaggerHubはSwagger Editor/UI/Codegenの機能がオールインワンになっています。つまり、Swagger SpecであるJSONやYAMLファイルをSwagger Editorで記述すると、ドキュメントもコードもSwagger UI/Codegenにより自動生成することができます。
https://news.mynavi.jp/itsearch/2018/08/20/Swagger3-300-250.jpg
今回はSwaggerHubを紹介します。SwaggerHubはSwagger Editor/UI/Codegenの機能がオールインワンになっています。つまり、Swagger SpecであるJSONやYAMLファイルをSwagger Editorで記述すると、ドキュメントもコードもSwagger UI/Codegenにより自動生成することができます。

会員登録(無料)

注目の特集/連載
AI人材に必要なもの
DMM.make AKIBAから生まれたスタートアップたち
はじめてのRPA導入
教えてカナコさん! これならわかるAI入門
RPA入門
PowerShell Core入門
Swagger 3.0 入門
徹底研究! ハイブリッドクラウド
マイナビニュース スペシャルセミナー 講演レポート/当日講演資料 まとめ

一覧はこちら

今注目のIT用語の意味を事典でチェック!

一覧はこちら

ページの先頭に戻る