My Swagger doc（別名Open API）で500個の応答コードを定義する必要がありますか？

Question

AutoRestのようなクライアントジェネレータを使用する予定の場合、生成されたクライアントに500のエラーを予想したいのですか？

または、try/catchでクライアントリクエストをラップすることを期待していますか？

これは私が作る必要がある文体的な決定ですか？

Answer 1

Swagger Codegen（無料、オープンソース）の場合、APIクライアントは通常、4xxまたは5xx HTTP応答の例外（たとえばデータベースに存在しないオブジェクトの削除など）を示す例外（通常はApiException） ApiExceptionオブジェクトには、サーバーから返されたエラーに関するすべての情報が含まれます。