はじめに
こんにちわ。Wano株式会社エンジニアのnariと申します。
突然ですが、皆さんはopenAPI仕様共有ツールに何を使っていますか?
Swagger周辺のツールを使っている方が多いのではないかなと思います。
しかし、フロント側やビジネス側の人間にも確認してもらいたかったり、いじってもらいたい場合、ymlやjsonベースのソースをいじってもらうのはなかなか難しいことも。。
そこで現在はGUIでいじれるApicurioというツールを試していて、かなり優秀だったので紹介させていただきます。
前回のツール選定の記事はこちら
Apicurio Studioとは
Design beautiful, functional APIs with zero coding, using OpenAPIがテーマ。
(https://www.apicur.io/ より抜粋)
Web Based,Code-optional Designを特徴としたOSSです。
Apicurio Studioのここが凄い
1.基本機能を無料で使用できるプラットフォームである
OSSとして提供されており、基本機能は完全無料で使うことができる
他のプラットフォーム系ツールが基本的に1メンバー平均20ドルくらいかかることを考えると、かなり素晴らしいです。。(Swagger-hubが月に90ドル（５メンバー）)
2.ソースリポジトリとのsyncが可能
- 現在github,bitbucket,gitlabに対応している
- コラボレイターも招待でき、複数人での管理ももちろん可能
3.GUIぽちぽちでOpenAPI仕様が作れる
- 以下のように、query parameterやpayloadの設定をGUIで設定できる(独自型も設定可能)
- もちろん直接ソースをいじることもできる
4.DocumentのUIが綺麗
- 他のOpenAPIツール同様Documentも生成できますが、そのUIがすごくみやすいです。(以下のimage参照)
- それぞれのapiの詳細とexampleを一見して見ることができる
- それぞれのapiの詳細とexampleを一見して見ることができる
Apicurio Studioの弱いところ
mockAPIの生成ができない
Roadmap | Apicurio Studio
によると将来的にできるようになるようですが、現在はできないので代替のものを使用する必要があります
その際、apisproutのdockerコンテナを自社サーバーに立てておいて、apicurioから吐き出したopenapi.ymlを読み込ませると、簡単にmockAPIを立てることができてお勧めです。
終わりに
Swagger一強と思われていますが、正直最終的にymlが吐き出せればなんでも良いのでGUIツールなんかを検討してみてもいいのかなと思います。
他にこんなツールがおすすめだよ、などあればぜひぜひ教えていただきたいです。