2016-04-04 6 views
0

Spring MVCを使用した既存のREST APIビルドがあります。 Swaggerを使用して社内文書を作成できるかどうかをすぐに確認するようになりました。スワッガー入出力モデルを手動で記述する(Javaドメインクラスなし)

私たちのREST実装の問題は、Spring MVCを使用してビジネスオブジェクトをjsonに変換することですが、ビジネスオブジェクトからJettison jsonオブジェクト(キー/値)を基本的に作成するカスタムjsonコンバータがあることです。現在、これを残念ながら変更する方法はありません。 入力btwも同じです。 基本的には常にクライアントに送信するハッシュマップです。

コントローラーを生成できるので、Springfoxを使用してメソッドを作成するとよいスタートです。 しかし、入出力についても文書化したいと考えています。 Swagger Annotationを使用して、Javaドメインクラスを参照せずに手動で入出力モデルを文書化する方法はありますか?

別の方法として、独自の低レベルのSwagger仕様を完全に記述したり、他のソリューションを検討したりすることができます。

答えて

0

なぜスプリングを使用しないのですか?rest-docs?私は、サービスモデルが本当に強く型付けされていないときに、あなたが必要とするものとまったく同じだと思います。それは利点のカップルはモデルが現実のすべての時間を反映します

    • はあなたではなく、外部からあなたのモデルを記述し、springfoxにそれを養うための方法を持つよりも、自分のエンドポイントのそれぞれのテストを書くことができることをint型持っていますインフラ。
    • モデルが外部から提供されていれば、何らかのテストを行わなくても現実的にこれらの変更を維持することは実際には不可能です。

    これはおそらくあなたがこの質問をしている理由ですが、明らかに、あなたのモデルには、キー値の変換

  • +0

    こんにちはDilip、私はSpring RESTDocsによく慣れています:-)現在、私はswagger仕様を生成するreqを持っています。 –

    +0

    簡単にはわかりません。プロジェクトでjettisonを使用する方法の例がありますか?私たちはおそらく道を見つけ出すことができます –

    +0

    おそらく簡単ではありません;-)それはJettison JSONObjectを作成するかなり低いレベルです。 json.put( "name"、name)キー/値を格納します。 –

    関連する問題