Swagger Viewerを使用してRESTful APIの設計書を管理しましょう！
Swagger Viewerを使用してRESTful APIの設計書を管理しましょう！
RESTful APIの設計書を作成することは、まるで捨ててしまうだけの作業のように感じることがありますよね。しかし、Swagger Viewerを利用することで、この問題を解決することができます！
Swagger Viewer
Swagger Viewerを開くには、以下の手順を実行します。
- コマンドパレットを開きます。
- 「Preview Swagger」と入力して選択します。
- ショートカットキー「shift + option + p」を押します。
これにより、VSCode上でSwagger Editorと同様に設計書をメンテナンスすることができます。
Swagger Viewerは以下の機能を提供します。
- 静的解析ツール：パスやコンポーネントが表示されるため、APIの設計におけるエラーを見つけやすくなります。
- コード補完機能：APIの設計中に、自動的にコードを補完することができます。
これらの機能を活用することで、以下のような開発モデルに切り替えることができます。
VScode plugins
Code First への転換
- openapi.ymlからcontrollerを生成する。
- openapi.ymlのメンテナンスが煩雑なため、controllerにコメントを追加するようにします。
- コードファーストの開発モデルにより、APIドキュメントを不要にする。
まとめ
以上がSwagger Viewerを使用してRESTful APIの設計書を管理する方法です。これによって、APIの開発効率を向上させることができますね！
Discussion