Swagger/OASドキュメントをSwaggerHubで管理しよう
最近の記事
SwaggerやOpen API Specification（以下OAS）はAPIのデファクトフォーマットになってきています。特にこれらのフォーマットでドキュメントを作っておくと、関連するライブラリやドキュメントが自動生成できるのが便利です。
Swagger/OASを使ったモックサーバであったり、テスト環境やエディタなどをまとめて提供してくれるのがSwaggerHubです。Swagger周辺のエコシステムを活用したい方はぜひ使ってみてください。
SwaggerHubについて
SwaggerHubはSwagger/OASファイルの編集とプレビュー、ドキュメント表示などに加えてモックサーバを立ち上げたり関連するサーバ、クライアント双方のライブラリが生成できます。
設定は公開することもできるので、そのままAPIドキュメントとして開発者に使ってもらうことができます。
仕組みとしてはGitHub風で、組織を作成してその中にプロジェクトを追加する形になります。
新しいAPIをイチから作ることもできますし、インポートにも対応しています。
テンプレートも用意されており、さらにSwagger/OASのどちらかを選択できます。なお、OASの場合は幾つかの機能が未実装になっています。
編集画面です。左側がエディタで、編集内容が右側に反映されます。こちらはOASでの記述となっています。
日本語も問題なく使えます。
APIのモックサーバを立ち上げることもできます。
サーバ、クライアントのライブラリ生成機能はSwaggerの場合のみ有効です。多くのプログラミング言語に対応しています。
SwaggerHubではユーザの作成した定義ファイルが公開されており、API設計を行う上での参考にもなります。また、モックサーバの立ち上げなどSwagger/OASを使った開発サイクルをサポートしていますので、ドキュメント以外の要素においてもSwagger/OASを活用していきたい時に役立つでしょう。
新規でこれから作っていく場合はもちろんのこと、既存のファイルをインポートすることもできます。Swagger/OASのエコシステムを活用する際にぜひ使ってみてください。