コード日進月歩

しんくうの技術的な小話、メモ、つれづれ、など

OpenAPI3.0でサクッとドキュメントを作るならSwaggerEditorでなんとかなるかも

久しぶりに使ったら今まで以上にすごい使いやすかったのでメモ

環境

https://editor.swagger.io

(ネット上で提供されているものは特に記載がない…)

良いポイント

強力なサジェスト

予約後の補完はもちろん、既存定義をひっぱってくる $ref などではすでに定義されているものがサジェストされる

リアルタイムプレビュー

言わずもがなの2ペイン方式で、記述したものはすぐに反映され、エラーがあればエラー内容がプレビュー画面に表記される

無料

他のEditor拡張はお金かかる場面があるが、料金もかからず使うことができる

辛いポイント

保存が曖昧

ブラウザにキャッシュが行われるため、保存タイミングが完全にブラウザ依存になるので「Ctrl+S」で保存するような方式ではないため書きかけのときのロストが不安

マシンが遅いとひっぱられる

ブラウザで操作する系にはつきものだが、Chromeなどで扱っているとメモリが逼迫手してきたときに動作が安定しなくなるタイミングがある

参考リンク