私は常に新しい機能 (API の変更) を追加している Java アプリケーションを維持しています。APIを文書化する方法としてOpenAPIを使用する方向に進みたいです。2 つの考え方があります。
- コードを記述し、いくつかの注釈を使用して OpenAPI 仕様を生成します。
- OpenAPI を作成し、それを使用してサーバー コードを生成します。
両方ともうまく機能しているように見えますが、サーバー コードは単純にスタブ化されているため、サービスを手動でプラグインする作業が多く必要になります。1回限りのコストとしては問題ないように思えますが、次にインターフェイスを更新するときは、次の2つのオプションしかないように思えます
- それらをすべて再度生成し、すべての手動配線をやり直します。
- 以前に生成されたクラスを手動で編集して、新しい仕様ファイルと一致させます (エラーが発生する可能性があります)。
これらのオプションは正しいですか？もしそうなら、コードを使用して api 仕様ファイルを生成することが、実際には唯一の適切な選択であるように思われます。