@ModelAttribute注釈付きメソッド内の@PathVariable注釈付きパラメータを自動的に文書化

Question

REST-APIでは、マルチテナント対応が必要です。

@RestController 
public class FooController extends ApiController { 

    @RequestMapping(value = "/foo", method = GET) 
    public List<Foo> getFoo(@ApiIgnore @ModelAttribute Tenant tenant) { 
    return service.getFoos(tenant); 
    } 

} 

：これをachivingために、すべての残りのコントローラは、要求のマッピングのプレフィックスを定義し、次のように

@RequestMapping(path = "/{tenantKey}/api") 
public class ApiController { 

    @ModelAttribute 
    public Tenant getTenant(@PathVariable("tenantKey") String tenantKey) { 
    return repository.findByTenantKey(tenantKey); 
    } 

} 

派生コントローラはモデルを使用すると、彼らの要求マッピング方法で属性を作るモデル属性を公開し、共通のRESTコントローラをサブクラス化

このエンドポイントは、swagger-uiで十分に文書化されています。パス/{tenantKey}/api/fooのGETマッピングで文書化されたエンドポイントを取得します。

私の問題は、{tenantKey}パス変数がパラメータとしてswagger-uiに記録されていないことです。 swaggerのパラメータセクションはまったくレンダリングされません。コントローラメソッドにStringパラメータを追加すると、@PathVariable("tenantKey)でアノテーションを付けても問題ありませんが、コントローラメソッドにtenantKeyパラメータは不要です。解決済みのテナントはすでにモデル属性として使用可能なためです。

私の質問は：この設定でApiControllerの@ModelAttriute注釈付きの方法から@PathVariableを取得する方法はありますか？

プロジェクトセットアップは

• 春ブーツ（1.4.2）
• springfox-swagger2である（2.6.1）
• springfox-闊歩-UI（2.6.1）

Answer 1

これは確かに可能です。メソッドのモデル属性は現在サポートされていません。代わりに、あなたは次のアプローチをとることができます。

1. マークとgetTenant方法@ApiIgnore（それが要求マッピングとして扱われますかどうかわからない。）あなたの整理で
2. あなたが（すべてのエンドポイントに）tenantKeyグローバルパス変数を追加することができます。これはマルチテナントアプリなので、これはすべてのエンドポイントに適用されると想定しています。