Stoplight Studio

OpenAPIでAPI仕様書を作る際に、yamlを手で書くのは面倒だなと思い何かいい方法がないか調べていたところ、下記の記事でStoplight Studioが紹介されていたので使ってみた。

本当に使ってよかったOpenAPI (Swagger) ツール | フューチャー技術ブログ

GUIのエディタでAPI定義を作っていけば自動でyamlコードが生成されるので非常に便利。

似たようなモデル定義をしたい際はコードエディタでコピーして、その後GUIで調整といった使い方もできる。

変更があるたびにLintが実行されるのでコミット前に定義ミスに気づけるのもとても良い。

記事内でも絶賛されていたが、たしかにOpenAPIの仕様書を作る際はStoplight Studioが必須といってもいいくらいに便利だった。

実際の仕様書を作る際もフューチャーさんの記事が参考になった。

スキーマファースト開発のためのOpenAPI(Swagger)設計規約 | フューチャー技術ブログ